Package org.serviceconnector.api

Class SCSubscribeMessage

java.lang.Object

org.serviceconnector.api.SCMessage

org.serviceconnector.api.SCSubscribeMessage

public class SCSubscribeMessage
extends SCMessage

The Class SCSubscribeMessage.

Constructor Summary

Constructors

Constructor	Description
SCSubscribeMessage()	Instantiates a new sC subscribe message.
SCSubscribeMessage(byte[] data)	Instantiates a new sC subscribe message with byte[] data.
SCSubscribeMessage(String data)	Instantiates a new sC subscribe message with String data.

Method Summary

Modifier and Type	Method	Description
String	getActualMask()	Gets the actual mask.
String	getMask()	Gets the mask.
int	getNoDataIntervalSeconds()	Gets the no data interval in seconds.
void	setActualMask(String actualMask)	Sets the actual mask.
void	setMask(String mask)	Sets the mask.
void	setNoDataIntervalSeconds(Integer noDataIntervalSeconds)	Sets the no data interval in seconds.

Methods inherited from class org.serviceconnector.api.SCMessage

getAppErrorCode, getAppErrorText, getCacheExpirationDateTime, getCacheId, getCachePartNr, getCachingMethod, getData, getDataLength, getMessageInfo, getPartSize, getServiceName, getSessionId, getSessionInfo, isCached, isCompressed, isManaged, isReject, setAppErrorCode, setAppErrorText, setCached, setCacheExpirationDateTime, setCacheId, setCachePartNr, setCachingMethod, setCompressed, setData, setDataLength, setMessageInfo, setPartSize, setReject, setServiceName, setSessionId, setSessionInfo, toString

Methods inherited from class java.lang.Object

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

Constructor Details

SCSubscribeMessage

public SCSubscribeMessage()

Instantiates a new sC subscribe message.

SCSubscribeMessage

public SCSubscribeMessage(byte[] data)

Instantiates a new sC subscribe message with byte[] data.

Parameters:

data - the data

SCSubscribeMessage

public SCSubscribeMessage(String data)

Instantiates a new sC subscribe message with String data.

Parameters:

data - the data

Method Details

getMask

public String getMask()

Gets the mask.

Returns:

the mask

setMask

public void setMask(String mask)

Sets the mask.

Parameters:

mask - Any printable character, length > 0 and < 256 Byte
Client may not subscribe with mask containing "%" character.
Example: "000012100012832102FADF-----------X-----------"

getActualMask

public String getActualMask()

Gets the actual mask. The actual client subscription mask filled by SC in SRV_CHANGE_SUBSCRIPTION.

Returns:

the actual mask

setActualMask

public void setActualMask(String actualMask)

Sets the actual mask.

Parameters:

actualMask - Validation: Any printable character, length < 256Byte.
Example: "000012100012832102FADF-----------X-----------"

getNoDataIntervalSeconds

public int getNoDataIntervalSeconds()

Gets the no data interval in seconds.

Returns:

the no data interval in seconds

setNoDataIntervalSeconds

public void setNoDataIntervalSeconds(Integer noDataIntervalSeconds)

Sets the no data interval in seconds. Interval in seconds the SC will wait to deliver RECEIVE_PUBLICATION response with noData flag set.

Parameters:

noDataIntervalSeconds - Validation: Number > 0 and < 3600
Example: 60