de.fhhannover.inform.trust.ifmapj.channel
Interface IfmapChannel

All Known Subinterfaces:
ARC, SSRC
All Known Implementing Classes:
ArcImpl, SsrcImpl

public interface IfmapChannel

Interface for an IF-MAP communication channel

Author:
aw

Method Summary
 void closeTcpConnection()
          Closes the underlying TCP connection.
 Result genericRequest(Request req)
          Generic Request Interface
 Result genericRequestWithSessionId(Request req)
           
 Integer getMaxPollResSize()
           
 String getPublisherId()
           
 String getSessionId()
           
 void setGzip(boolean useGzip)
          Specifies whether GZIP compression should be used.
 void setMaxPollResSize(Integer mprs)
          Set the max-poll-result-size for this channel.
 void setPublisherId(String publisherId)
          Set the ifmap-publisher-id for this channel.
 void setSessionId(String sessionId)
          Set the session-id to be used for this channel.
 boolean usesGzip()
          Indicates whether GZIP compression is used by this channel
 

Method Detail

getSessionId

String getSessionId()
Returns:
the current session-id for this channel, either set by a call to SSRC.newSession() or setSessionId(String), or null if none of these calls was made.

setSessionId

void setSessionId(String sessionId)
Set the session-id to be used for this channel. Be aware, calling this on an ARC will change the SSRC object attached to the ARC. Calling it on an SSRC will also change the attached ARC objects for the SSRC.


getPublisherId

String getPublisherId()
Returns:
the current ifmap-publisher-id for this channel, either set by a call to SSRC.newSession() or setPublisherId(String), or null if none of these calls was made.

setPublisherId

void setPublisherId(String publisherId)
Set the ifmap-publisher-id for this channel. Be aware, calling this on an ARC will change the SSRC object attached to the ARC. Calling it on an SSRC will also change the attached ARC objects for the SSRC. This call will only result in having getPublisherId() return the set value. Requests won't be influenced.


getMaxPollResSize

Integer getMaxPollResSize()
Returns:
the current max-poll-result-size for this channel, either set by a call to SSRC.newSession() or setMaxPollResSize(Integer), or null if none of these calls was made.

setMaxPollResSize

void setMaxPollResSize(Integer mprs)
Set the max-poll-result-size for this channel. Be aware, calling this on an ARC will change the SSRC object attached to the ARC. Calling it on an SSRC will also change the attached ARC objects for the SSRC. This call will only result in having getMaxPollResSize() return the set value. Requests won't be influenced.


closeTcpConnection

void closeTcpConnection()
                        throws CommunicationException
Closes the underlying TCP connection.

Throws:
CommunicationException

setGzip

void setGzip(boolean useGzip)
Specifies whether GZIP compression should be used.

Parameters:
useGzip - true if GZIP should be used

usesGzip

boolean usesGzip()
Indicates whether GZIP compression is used by this channel

Returns:
true, if GZIP is used

genericRequest

Result genericRequest(Request req)
                      throws IfmapErrorResult,
                             IfmapException
Generic Request Interface

Parameters:
req -
Returns:
Throws:
IfmapErrorResult
IfmapException

genericRequestWithSessionId

Result genericRequestWithSessionId(Request req)
                                   throws IfmapErrorResult,
                                          IfmapException
Throws:
IfmapErrorResult
IfmapException


Copyright © 2012 Trust@FHH. All Rights Reserved.