Package org.serviceconnector.service

Class Subscription

java.lang.Object

org.serviceconnector.service.AbstractSession

org.serviceconnector.service.Subscription

public class Subscription
extends AbstractSession

The Class Subscription.

Field Summary

Fields inherited from class org.serviceconnector.service.AbstractSession

ipAddressList, server

Constructor Summary

Constructors

Constructor	Description
Subscription(SubscriptionMask mask, String sessionInfo, String ipAddressList, int noDataInterval, double subscriptionTimeoutMillis, boolean cascaded)	Instantiates a new subscription.

Method Summary

Modifier and Type	Method	Description
void	addCscSubscriptionId(String cscSubscriptionId, SubscriptionMask cscMask)	Adds the csc subscription id.
void	dump(XMLDumpWriter writer)	Dump the subscription into the xml writer.
Map<String,SubscriptionMask>	getCscSubscriptionIds()	Gets the csc subscription ids.
SubscriptionMask	getMask()	Gets the mask.
int	getNoDataIntervalMillis()	Gets the no data interval.
IStatefulServer	getServer()	Gets the server.
double	getSubscriptionTimeoutMillis()	Gets the subscription timeout millis.
void	removeCscSubscriptionId(String cscSubscriptionId)	Removes the csc subscription id.
void	setMask(SubscriptionMask mask)	Sets the mask.

Methods inherited from class org.serviceconnector.service.AbstractSession

getCreationTime, getId, getIpAddressList, getService, getSessionInfo, getTimeout, getTimeouterTask, isCascaded, setServer, setService, setTimeout, setTimeouterTask, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Subscription

public Subscription(SubscriptionMask mask,
 String sessionInfo,
 String ipAddressList,
 int noDataInterval,
 double subscriptionTimeoutMillis,
 boolean cascaded)

Instantiates a new subscription.

Parameters:

mask - the mask

sessionInfo - the session info

ipAddressList - the ip address list

noDataInterval - the no data interval

subscriptionTimeoutMillis - the subscription timeout millis

cascaded - the cascaded

Method Details

getMask

public SubscriptionMask getMask()

Gets the mask.

Returns:

the mask

setMask

public void setMask(SubscriptionMask mask)

Sets the mask.

Parameters:

mask - the new mask

getSubscriptionTimeoutMillis

public double getSubscriptionTimeoutMillis()

Gets the subscription timeout millis.

Returns:

the subscription timeout millis

getServer

public IStatefulServer getServer()

Gets the server.

Overrides:

getServer in class AbstractSession

Returns:

the server the server

getNoDataIntervalMillis

public int getNoDataIntervalMillis()

Gets the no data interval.

Returns:

the no data interval

addCscSubscriptionId

public void addCscSubscriptionId(String cscSubscriptionId,
 SubscriptionMask cscMask)

Adds the csc subscription id.

Parameters:

cscSubscriptionId - the csc subscription id

cscMask - the csc mask

removeCscSubscriptionId

public void removeCscSubscriptionId(String cscSubscriptionId)

Removes the csc subscription id.

Parameters:

cscSubscriptionId - the csc subscription id

getCscSubscriptionIds

public Map<String,SubscriptionMask> getCscSubscriptionIds()

Gets the csc subscription ids.

Returns:

the csc subscription ids

dump

public void dump(XMLDumpWriter writer)
          throws Exception

Dump the subscription into the xml writer.

Specified by:

dump in class AbstractSession

Parameters:

writer - the writer

Throws:

Exception - the exception