|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.autonomy.aci.services.AciService
com.autonomy.aci.services.DiSHService
Service class for reading from the DiSH controller of IDOL server. The class provides methods for reading information about the DISH's child services.
Constructor Summary | |
DiSHService()
Construct an DiSHService that is not pointing to any installed IDOL server. |
|
DiSHService(AciConnectionDetails aciServiceDetails)
Construct an DiSHService that is pointing to the specified IDOL server. |
|
DiSHService(java.lang.String szHostName,
int nAciPort)
Construct an DiSHService that is pointing to the specified IDOL server. |
Method Summary | |
AciResponse |
addChild(DiSHChild child)
|
AciResponse |
addInterface(java.lang.String sInterfaceName,
DiSHChild child)
|
AciResponse |
executeAction(AciAction aciaAction)
Send an Aci action command to the server. |
int |
getAciPort()
Get the Aci port of the server. |
DiSHChild |
getChild(java.lang.String sChildName)
Reads the details of the specified child service from DiSH. |
java.util.ArrayList |
getChildren()
Reads the details of all the child services of the DiSH. |
AciConnectionDetails |
getConnectionDetails(java.lang.String sChildName)
Reads the ACI connection details of the specified child service from DiSH. |
java.lang.String |
getEncoding()
Read the character encoding being used to communicate with the Aci server. |
EncryptionDetails |
getEncryptionDetails()
Get encryption details of the Aci connection. |
java.lang.String |
getHost()
Get the hostname or IP address of the server. |
DiSHChild |
getInterface(java.lang.String sInterfaceName)
|
LicensedFunctionality |
getLicensedFunctionality()
Queries DiSH to obtain a list of licensed functionality. |
int |
getRetries()
Get the number of retries of the Aci connection. |
int |
getTimeout()
Get the timeout of the Aci connection (milliseconds). |
AciResponse |
removeChild(DiSHChild child)
|
AciResponse |
removeInterface(java.lang.String sInterfaceName)
|
void |
setAciPort(int nAciPort)
Set the Aci port of the server. |
void |
setEncoding(java.lang.String sEncoding)
Set the character encoding used to communicate with the Aci server. |
void |
setEncryptionDetails(EncryptionDetails encryptionDetails)
Set encryption details of the Aci connection. |
void |
setHost(java.lang.String szHostName)
Set the hostname or IP address of the server. |
void |
setRetries(int nRetries)
Set the retries of the Aci connection. |
void |
setTimeout(int nTimeout)
Set the timeout of the Aci connection (milliseconds). |
java.lang.String |
URLEncode(java.lang.String sToEncode)
Encode a string for inclusion in a URL according to the character encoding being used by the service. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public DiSHService()
public DiSHService(AciConnectionDetails aciServiceDetails)
aciServiceDetails
- connection details of the IDOL server giving at least the host name and
DiSH ACI port of the IDOL server.public DiSHService(java.lang.String szHostName, int nAciPort)
szHostName
- the host name of the machine on which the IDOL server is running.nAciPort
- the DiSH ACI port of the IDOL server.Method Detail |
public DiSHChild getChild(java.lang.String sChildName) throws AciException, ChildNotFoundException
sChildName
- the name of the child service as configured on DiSH.
DiSHChild
containing all the details of the child service.
AciException
- if there was an error when making the request.
ChildNotFoundException
- if the specified service is not a child service of DiSH.public AciResponse addChild(DiSHChild child) throws AciException
AciException
public AciResponse removeChild(DiSHChild child) throws AciException
AciException
public DiSHChild getInterface(java.lang.String sInterfaceName) throws AciException, ChildNotFoundException
AciException
ChildNotFoundException
public AciResponse addInterface(java.lang.String sInterfaceName, DiSHChild child) throws AciException, ChildNotFoundException
AciException
ChildNotFoundException
public AciResponse removeInterface(java.lang.String sInterfaceName) throws AciException
AciException
public AciConnectionDetails getConnectionDetails(java.lang.String sChildName) throws AciException, ChildNotFoundException
sChildName
- the name of the child service as configured on DiSH.
AciConnectionDetails
containing the ACI connection details of
the child service.
AciException
- if there was an error when making the request.
ChildNotFoundException
- if the specified service is not a child service of DiSH.public java.util.ArrayList getChildren() throws AciException
ArrayList
of DiSHChild
objects representing all the child
services defined on the DiSH. If no child services are configured, the ArrayList
is
empty.
AciException
- if there was an error when making the request.
DiSHException
public LicensedFunctionality getLicensedFunctionality() throws AciException, InvalidLicenseFileException
LicensedFunctionality
defining licensed functionality.
AciException
- if there was an error when making the request.
InvalidLicenseFileException
- if DiSH could not find a valid license key file.public void setHost(java.lang.String szHostName)
szHostName
- the hostname or IP address of the server.public java.lang.String getHost()
public void setAciPort(int nAciPort)
nAciPort
- the Aci port of the server.public int getAciPort()
public void setTimeout(int nTimeout)
nTimeout
- the timeout of the Aci connection (milliseconds).public int getTimeout()
public void setRetries(int nRetries)
nRetries
- the number of retries of the Aci connection.public int getRetries()
public AciResponse executeAction(AciAction aciaAction) throws AciException
aciaAction
- the AciAction
object encapsulating the action to send.
AciResponse
linked list representing the response from the Aci server.
Warning: Can be null if connection timed out.
AciException
- or one of its subclasses if an error occurred while executing the given action.public void setEncoding(java.lang.String sEncoding) throws java.io.UnsupportedEncodingException
sEncoding
- the name of the character encoding to use.
java.io.UnsupportedEncodingException
- if the encoding is not supported by the JVM being used.public java.lang.String getEncoding()
public java.lang.String URLEncode(java.lang.String sToEncode)
sToEncode
- the string to encode.
public void setEncryptionDetails(EncryptionDetails encryptionDetails)
encryptionDetails
- implementation of EncryptionDetails object.public EncryptionDetails getEncryptionDetails()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |