|
| |
|
| java.lang.Object
 org.datashare.objects.DefaultObjectInfo
org.datashare.ChannelInfo
| Field Summary | |
| final static long | serialVersionUID
this allows us to serialize this class without 'marshalling' errors. |
| serialVersionUID | | final static long serialVersionUID(Code) | | this allows us to serialize this class without 'marshalling' errors.
|
| addConsumerClient | | public void addConsumerClient(ConsumerInfo consumer)(Code) | | adds a Client/Consumer to this Channel
Parameters:
consumer - the consumer to add |
| checkForConsumer | | public boolean checkForConsumer(ConsumerInfo consumer)(Code) | | checks to see if a Consumer is already in this Channel
|
| getConnectionDescriptor | | public DataShareConnectionDescriptor getConnectionDescriptor()(Code) | | Retrieves the Channel descriptor (so an instance of a DataShareConnection can be created),
can return a null.
|
| getConsumerTable | | public Hashtable getConsumerTable()(Code) | | returns the Hashtable of Consumers for this Channel
the list of consumers, keyed by name |
| getDataReceiverAdapter | | public DataReceiverAdapter getDataReceiverAdapter()(Code) | | Retrieves the DataReceiverAdapter for this Channel
|
| getDatabaseID | | public String getDatabaseID()(Code) | | Retrieves the ADSKey String for this instance. Should always be checked for null.
Also realize that this method may block until the ADSKey value is available.
the ADSKey String that was previously set for this instance. |
| getFunction | | public String getFunction()(Code) | | Determines what type of HC function this Channel should be used for. The
correct answers are one of the 'supported' HC Functions
the HC Function that would normally use a Channel by this name |
| getInfo | | public String getInfo()(Code) | | Retrieves a description of this instance.
information about this instance |
| getObject | | public Object getObject()(Code) | | Retrieves an Object reference of this instance, used when this class
is cast to the parent class for common handling of DSObjectInfo objects. May return
null if constructor that does not have Channel as parameter was used to construct this
instance.
the Channel instance as an Object (may be null) |
| getSaveDataForThisChannel | | public boolean getSaveDataForThisChannel()(Code) | | returns an indicator for whether or not EJBs are saved for this Channel's data
returns true if beans are in use for this channel |
| getSessionInfo | | public SessionInfo getSessionInfo()(Code) | | Retrieves the Channel's parent Session, may be null depending on which
constructor was used to create this instance.
a reference to this Channel's parent Session (may be null) |
| getType | | public String getType()(Code) | | Retrieves a string containing 'Channel'.
fixed value of 'Channel' for all instances, used when this classis referenced by it's parent class so all subclasses have a commonmethod that can be used to test for the instance type. |
| removeConsumerClient | | public void removeConsumerClient(ConsumerInfo consumer)(Code) | | removes a Client/Consumer from this Channel
Parameters:
consumer - the consumer to remove |
| setDatabaseID | | public void setDatabaseID(String ak)(Code) | | Sets the ADSKey String for this instance to the provided parameter value.
The ADSKey String is the value provided when the EJB was created for this instance.
Parameters:
ak - the value to save as the ID for this instance |
| setSaveDataForThisChannel | | public void setSaveDataForThisChannel(boolean saveData)(Code) | | sets the indicator for whether or not EJBs should be used for this Channel's Data.
Default value is true.
Parameters:
useBeans - true if beans are to be used, false otherwise |
| setSessionInfo | | public void setSessionInfo(SessionInfo sessionInfo)(Code) | | Sets the Channel's parent Session, only used when this ChannelInfo instance
is retrieved from persistence because normally the sessionInfo would have been
set by the constructor
Parameters:
sessionInfo - reference to this Channel's parent Session |
| shutDown | | public void shutDown()(Code) | | Shuts down all the sockets associate with this Channel
|
|
|
|