| java.lang.Object
 org.datashare.objects.ChannelDescription
| ChannelDescription | | public class ChannelDescription implements java.io.Serializable(Code) | | Used to describe a Channel that a Client should use to communicate with
the DataShareServer. The Channel described is a data channel that the
DataShareServer will use to exchange data between clients that are connected
to it. This object is not sent directly, but instead is sent by the
DataShareServer over the commandStatusChannel as part of a
ChannelDescriptionArray object.
since:
Version 2
author:
Charles Wood
See Also: ChannelDescriptionArray |
| Field Summary | |
| final public static int | MULTICAST
| | final public static int | TCP
| | final public static int | UDP
| | final public static int | UNKNOWN
| | public boolean | allowPersistSelection
| | public String | archiveChannelClass
Provides the DataShareServer with the the class used to handle data for
this Channel (the class of the Rendezvous function) when archiving this Channel's
data to DocumentKonnect. | | public String | archiveChannelGetDataMethod
Provides the DataShareServer with the method to call in the archiveChannelClass
to genereate the DocumentKonnect file (after all the EJB persisted data has
been sent to the archiveChannelSetDataMethod). | | public String | archiveChannelSetDataMethod
Provides the DataShareServer with the method in the archiveChannelClass
to call so that the data that was archived to EJBs can be re-processed prior
to calling the archiveChannelGetDataMethod to create the file for DocumentKonnect. | | public String | channelClass
Provides Clients with the the class used to handle data for this Channel
(the class of the Rendezvous function), applies only to data channels for Rendezvous Functions,
otherwise, not used. | | public String | channelDescription
| | public String | channelJarFileName
provides the Client with the name of the jar file in which to look for the
channelClass, used only for Rendezvous functions. | | public String | channelName
| | public String | fileExtension
| | public int | historyCountInc
used as the count of how many EJBs to retrieve at one time when getting ready to send data
to clients as history. | | public int | historyDelay
used to set the delay that the server inserts between each packet sent to a client when
history has been requested. | | public String | mimeType
| | public boolean | persist
| | public boolean | selectionPreSet
indicates that the Client should this Channel's checkBox pre-checked in the
New Session Dialog Frame, indicating a desire to have this type of Channel
in a Session. | | final static long | serialVersionUID
this allows us to serialize this class without 'marshalling' errors. | | public int | type
| | final public static String[] | validTypes
Used when a String representation of the type attribute is desired, the type value
is the index into this array. |
| Constructor Summary | |
| public | ChannelDescription()
Constructor, should only be used when creating the command status connection.
The only information needed by a client to create the commandStatus connection
is the Server IP address and port number. | | public | ChannelDescription(String channelName, String channelDescription, int channelType)
Constructor, should only be used when creating a single channel (per Session)
data connection for a non-PpKClient client. | | public | ChannelDescription(String channelName, String channelClass, String channelDescription, int type, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc)
| | public | ChannelDescription(String channelName, String channelClass, String channelDescription, String channelType, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc)
| | public | ChannelDescription(String channelName, String channelClass, String channelDescription, int type, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc, String mimeType, String fileExtension, String archiveChannelClass, String archiveChannelSetDataMethod, String archiveChannelGetDataMethod)
| | public | ChannelDescription(String channelName, String channelClass, String channelDescription, String channelType, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc, String mimeType, String fileExtension, String archiveChannelClass, String archiveChannelSetDataMethod, String archiveChannelGetDataMethod)
|
| MULTICAST | | final public static int MULTICAST(Code) | | valid value for the 'type' attribute, used for Multicast type connections
|
| TCP | | final public static int TCP(Code) | | valid value for the 'type' attribute, used for TCP type connections
|
| UDP | | final public static int UDP(Code) | | valid value for the 'type' attribute, used for UDP type connections
|
| UNKNOWN | | final public static int UNKNOWN(Code) | | valid value for the 'type' attribute used when the connection is unknown
|
| allowPersistSelection | | public boolean allowPersistSelection(Code) | | indicates if this function is allowed to persist data, true indicates that it is,
false indicates that this function should never save any data (persist will be set to
false and the user should not be offered the persist data option)
|
| archiveChannelClass | | public String archiveChannelClass(Code) | | Provides the DataShareServer with the the class used to handle data for
this Channel (the class of the Rendezvous function) when archiving this Channel's
data to DocumentKonnect. Note that the full package name is required.
|
| archiveChannelGetDataMethod | | public String archiveChannelGetDataMethod(Code) | | Provides the DataShareServer with the method to call in the archiveChannelClass
to genereate the DocumentKonnect file (after all the EJB persisted data has
been sent to the archiveChannelSetDataMethod).
|
| archiveChannelSetDataMethod | | public String archiveChannelSetDataMethod(Code) | | Provides the DataShareServer with the method in the archiveChannelClass
to call so that the data that was archived to EJBs can be re-processed prior
to calling the archiveChannelGetDataMethod to create the file for DocumentKonnect.
|
| channelClass | | public String channelClass(Code) | | Provides Clients with the the class used to handle data for this Channel
(the class of the Rendezvous function), applies only to data channels for Rendezvous Functions,
otherwise, not used. Note that the full package name is required.
|
| channelDescription | | public String channelDescription(Code) | | descriptive comment about the Channel, used for display purposes only
|
| channelJarFileName | | public String channelJarFileName(Code) | | provides the Client with the name of the jar file in which to look for the
channelClass, used only for Rendezvous functions.
|
| channelName | | public String channelName(Code) | | Provides the name of this Channel
|
| fileExtension | | public String fileExtension(Code) | | indicates the file extension for the file genererated by the data in this
Channel if the data is to be archived to DocumentKonnect
|
| historyCountInc | | public int historyCountInc(Code) | | used as the count of how many EJBs to retrieve at one time when getting ready to send data
to clients as history. A negative, or zero count indicates get next EJB, send it, repeat...
|
| historyDelay | | public int historyDelay(Code) | | used to set the delay that the server inserts between each packet sent to a client when
history has been requested.
|
| mimeType | | public String mimeType(Code) | | indicates what type of file is generated by the data in this Channel if the
data is to be archived to DocumentKonnect
|
| persist | | public boolean persist(Code) | | indicates if DataShareServer is persisting the data in this Channel to EJBs
|
| selectionPreSet | | public boolean selectionPreSet(Code) | | indicates that the Client should this Channel's checkBox pre-checked in the
New Session Dialog Frame, indicating a desire to have this type of Channel
in a Session. The user has to de-select the check box to avoid putting this
type of Channel into a Session.
|
| serialVersionUID | | final static long serialVersionUID(Code) | | this allows us to serialize this class without 'marshalling' errors.
|
| type | | public int type(Code) | | describes the type of Channel, valid values are TCP, UDP, and MULTICAST
|
| validTypes | | final public static String[] validTypes(Code) | | Used when a String representation of the type attribute is desired, the type value
is the index into this array.
|
| ChannelDescription | | public ChannelDescription()(Code) | | Constructor, should only be used when creating the command status connection.
The only information needed by a client to create the commandStatus connection
is the Server IP address and port number. All other information is set by this
empty constructor.
|
| ChannelDescription | | public ChannelDescription(String channelName, String channelDescription, int channelType)(Code) | | Constructor, should only be used when creating a single channel (per Session)
data connection for a non-PpKClient client. There will be no history available.
param channelType must be choosen from ChannelDescription.TCP, ChannelDescription.UDP,
or ChannelDescription.MULTICAST
|
| ChannelDescription | | public ChannelDescription(String channelName, String channelClass, String channelDescription, int type, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc)(Code) | | Constructor, describes a Channel that will not be archived
Parameters:
channelName - sets instance variable channelName
Parameters:
channelClass - sets instance variable channelClass
Parameters:
channelDescription - sets instance variable channelDescription
Parameters:
type - sets instance variable type
Parameters:
channelJarFileName - sets instance variable channelJarFileName
Parameters:
allowPersistSelection - set instance variable allowPersistSelection
Parameters:
persist - sets instance variable persist
Parameters:
selectionPreSet - sets instance variable selectionPreSet
Parameters:
historyDelay - sets the time to delay between sending packets from history, zero is no delay
Parameters:
historyCountInc - set the number of EJBs to retrieve from history per call to getData() |
| ChannelDescription | | public ChannelDescription(String channelName, String channelClass, String channelDescription, String channelType, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc)(Code) | | Constructor, describes a Channel that will not be archived, differs from the
previous constructor by using a String for the type parameter
Parameters:
channelName - sets instance variable channelName
Parameters:
channelClass - sets instance variable channelClass
Parameters:
channelDescription - sets instance variable channelDescription
Parameters:
type - sets instance variable type
Parameters:
channelJarFileName - sets instance variable channelJarFileName
Parameters:
allowPersistSelection - set instance variable allowPersistSelection
Parameters:
persist - sets instance variable persist
Parameters:
selectionPreSet - sets instance variable selectionPreSet
Parameters:
historyDelay - sets the time to delay between sending packets from history, zero is no delay
Parameters:
historyCountInc - set the number of EJBs to retrieve from history per call to getData() |
| ChannelDescription | | public ChannelDescription(String channelName, String channelClass, String channelDescription, int type, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc, String mimeType, String fileExtension, String archiveChannelClass, String archiveChannelSetDataMethod, String archiveChannelGetDataMethod)(Code) | | Constructor, describes a Channel that may be archived
Parameters:
channelName - sets instance variable channelName
Parameters:
channelClass - sets instance variable channelClass
Parameters:
channelDescription - sets instance variable channelDescription
Parameters:
type - sets instance variable type
Parameters:
channelJarFileName - sets instance variable channelJarFileName
Parameters:
allowPersistSelection - set instance variable allowPersistSelection
Parameters:
persist - sets instance variable persist
Parameters:
selectionPreSet - sets instance variable selectionPreSet
Parameters:
historyDelay - sets the time to delay between sending packets from history, zero is no delay
Parameters:
historyCountInc - set the number of EJBs to retrieve from history per call to getData()
Parameters:
mimeType - sets instance variable mimeType
Parameters:
fileExtension - sets instance variable fileExtention
Parameters:
archiveChannelClass - sets instance variable archiveChannelClass
Parameters:
archiveChannelSetDataMethod - sets instance variable archiveChannelSetDataMethod
Parameters:
archiveChannelGetDataMethod - set instance variable archiveChannelGetDataMethod |
| ChannelDescription | | public ChannelDescription(String channelName, String channelClass, String channelDescription, String channelType, String channelJarFileName, boolean allowPersistSelection, boolean persist, boolean selectionPreSet, int historyDelay, int historyCountInc, String mimeType, String fileExtension, String archiveChannelClass, String archiveChannelSetDataMethod, String archiveChannelGetDataMethod)(Code) | | Constructor, describes a Channel that may be archived, uses String for the type parameter
Parameters:
channelName - sets instance variable channelName
Parameters:
channelClass - sets instance variable channelClass
Parameters:
channelDescription - sets instance variable channelDescription
Parameters:
type - sets instance variable type
Parameters:
channelJarFileName - sets instance variable channelJarFileName
Parameters:
allowPersistSelection - set instance variable allowPersistSelection
Parameters:
persist - sets instance variable persist
Parameters:
selectionPreSet - sets instance variable selectionPreSet
Parameters:
historyDelay - sets the time to delay between sending packets from history, zero is no delay
Parameters:
historyCountInc - set the number of EJBs to retrieve from history per call to getData()
Parameters:
mimeType - sets instance variable mimeType
Parameters:
fileExtension - sets instance variable fileExtention
Parameters:
archiveChannelClass - sets instance variable archiveChannelClass
Parameters:
archiveChannelSetDataMethod - sets instance variable archiveChannelSetDataMethod
Parameters:
archiveChannelGetDataMethod - set instance variable archiveChannelGetDataMethod |
|
|