public class CSEndpointWorker extends CSItem
The CSEndpointWorker
class includes methods for the retrieval of a particular endpoint worker's details.
All such methods require that certain database and key information (endpoint ID, for example) be specified via the
set
methods provided, prior to their invocation.
All database access/connectivity is handled internally by the CSEndpointWorker
class.
CSEndpointWorkerContent
,
Serialized FormACCESS_GRANTED, DOES_NOT_EXIST, EMPTY, EXISTS, SECURE_ACCESS_DENIED, SECURE_ACCESS_GRANTED, UPDATE_ACTION_INSERTED, UPDATE_ACTION_UPDATED
LEVEL_ALL, LEVEL_ALL_PLUS_RELATED, LEVEL_DETAIL, LEVEL_ID, LEVEL_SUMMARY
Constructor and Description |
---|
CSEndpointWorker()
Creates an empty
CSEndpointWorker object. |
CSEndpointWorker(java.lang.String strPropertyFile)
Creates a new
CSEndpointWorker object, specifying a property file that contains all of the required database
connection details. |
Modifier and Type | Method and Description |
---|---|
void |
delete()
Not currently implemented for
CSEndpointWorker . |
void |
get()
Retrieves the details of a end point from the database.
|
java.lang.String |
getDescription()
Gets the description of the endpoint worker.
|
java.util.List<CSPublishedEndpoint> |
getEndpoints()
Gets a list of published endpoints if
setRetrieveEndpoints(boolean)
was set to true before the call to get() . |
int |
getEndpointWorkerID()
Gets the endpoint worker ID currently specified as key information.
|
java.lang.String |
getName()
Gets the name of the endpoint worker.
|
boolean |
getRetrieveEndpoints()
Returns true if comprehensive details of all published endpoints targeted to
the worker identified by its name or ID should be returned.
|
void |
setDescription(java.lang.String endpointDescription)
Sets the description of the endpoint worker.
|
void |
setDetailLevel(int nDetailLevel)
Sets the level of detail to be handled by the
get method. |
void |
setEndpointWorkerID(int endpointWorkerID)
Sets the endpoint worker ID to be used as key information.
|
void |
setName(java.lang.String endpointName)
Sets the name of the endpoint worker.
|
void |
setRetrieveEndpoints(boolean retrieveEndpoints)
Sets the description of the endpoint worker.
|
java.lang.String |
toString()
Provides debug information on the contents of the
CSEndpointWorker object. |
void |
update()
Not currently implemented for
CSEndpointWorker . |
equals, exist, getID, getStatus, hashCode, jsonString, serialiseWithTypes, setID, setStatus, unset
clearRecordedGatewayMessages, clone, count, getCache, getCachingEnabled, getDatabaseVersion, getDatabaseVersion, getDebugOutput, getDetailLevel, getPreview, getPropertyFile, getPropertyFileExtension, getPropertyFilePathname, getRecordedGatewayMessages, getRecordGatewayMessages, getSendGatewayMessages, getUseCache, setDebugOutput, setPreview, setPropertyFile, setRecordGatewayMessages, setSendGatewayMessages, setUseCache
public CSEndpointWorker()
CSEndpointWorker
object.
Use the various set
methods provided to initialise the CSEndpointWorker
object prior to
invoking any of its query methods.
public CSEndpointWorker(java.lang.String strPropertyFile)
CSEndpointWorker
object, specifying a property file that contains all of the required database
connection details.
Use the various set methods provided to initialise the CSEndpointWorker
object prior to invoking any of its
query manipulation methods.
strPropertyFile
- the property file that contains the connection details.public int getEndpointWorkerID()
public void setEndpointWorkerID(int endpointWorkerID)
setEndpointWorkerID
followed by a call to get
will return details of the
endpoint worker with the specified endpoint worker ID.
endpointWorkerID
- the integer ID of the endpoint worker to be retrieved.public java.lang.String getName()
String
object.public void setName(java.lang.String endpointName)
endpointName
- the endpoint worker's name as a String
object.public java.lang.String getDescription()
String
object.public void setDescription(java.lang.String endpointDescription)
endpointDescription
- the endpoint worker's description as a String
object.public java.util.List<CSPublishedEndpoint> getEndpoints()
setRetrieveEndpoints(boolean)
was set to true before the call to get()
.
String
object.public boolean getRetrieveEndpoints()
public void setRetrieveEndpoints(boolean retrieveEndpoints)
public void setDetailLevel(int nDetailLevel) throws CSParameterException
get
method.
Valid detail levels for an end point worker are :
LEVEL_ID
Retrieves the EndpointWorkerID only. If retrieveEndpoints is set to true this detail level
will be used for the CSPublishedEndpoint calls. See CSPublishedEndpoint.setDetailLevel(int)
for more info.
LEVEL_SUMMARY
Retrieves everything in previous detail levels, plus WorkerName and Description. If retrieveEndpoints is set to true this detail level
will be used for the CSPublishedEndpoint calls. See CSPublishedEndpoint.setDetailLevel(int)
for more info.
LEVEL_DETAIL
Retrieves everything in previous detail levels. If retrieveEndpoints is set to true this detail level
will be used for the CSPublishedEndpoint calls. See CSPublishedEndpoint.setDetailLevel(int)
for more info.
LEVEL_ALL
Retrieves everything in previous detail levels. If retrieveEndpoints is set to true this detail level
will be used for the CSPublishedEndpoint calls. See CSPublishedEndpoint.setDetailLevel(int)
for more info.
setDetailLevel
in class CSDatabaseItem
nDetailLevel
- the detail level to be used.CSParameterException
- if an invalid detail level is specified.public void get() throws CSException
Use setEndpointWorkerID
or
setName
followed by get
to populate this CSEndpointWorker
object with the details of the endpoint worker identified by the specified ID or name.
get
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if the specified attribute cannot be found on the database.CSSecurityException
- if security has been breached.CSException
- the base class for exceptions thrown by this method.public void delete() throws CSException
CSEndpointWorker
.
delete
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified attributes cannot be found on the database.CSException
- the base class for exceptions thrown by this method.public void update() throws CSException
CSEndpointWorker
.
update
in class CSItem
CSParameterException
- if an invalid combination of key information has been supplied.CSDatabaseException
- if there are problems accessing the database.CSNotFoundException
- if one of the specified attributes cannot be found on the database.CSException
- the base class for exceptions thrown by this method.Copyright © 2022 Goss Interactive Ltd. All Rights Reserved.