|
![]() |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.autonomy.client.aciObject
aciObject
is the fundamental construct in the ACI client API . You can use the aciObject
objects as a:
aciObject
provides functions for accessing and manipulating the aciObject
linked list.aciObject
should have a publicly available constructor taking one Integer
parameter if linked lists of the extended aciObject
are to be created by aciObjectExecute
and
parseResultString
.
Field Summary | |
static java.lang.String |
ACI_COM_COMMAND
Specifies the action parameter of a command type aciObject |
static java.lang.String |
ACI_COM_INDEX_DATA
Specifies the index data parameter of a command type aciObject |
static java.lang.String |
ACI_COM_METHOD
Deprecated. Use ACI_COM_USE_POST instead. |
static java.lang.String |
ACI_COM_USE_MULTIPART
Specifies the use multipart parameter of a command type aciObject |
static java.lang.String |
ACI_COM_USE_POST
Specifies the HTTP method parameter of a command type aciObject |
static int |
ACI_COMMAND
Specifies a command type aciObject. |
static java.lang.String |
ACI_CONN_RECVENCODING
Specifies the recieving character encoding parameter of a connection type aciObject |
static java.lang.String |
ACI_CONN_RETRIES
Specifies the number of retries parameter of a connection type aciObject |
static java.lang.String |
ACI_CONN_SENDENCODING
Specifies the sending character encoding parameter of a connection type aciObject |
static java.lang.String |
ACI_CONN_TIMEOUT
Specifies the timeout parameter of a connection type aciObject |
static int |
ACI_CONNECTION
Specifies a connection type aciObject. |
static int |
ACI_DATA
Specifies a data type aciObject. |
static java.lang.String |
ACI_DATA_DATA
Specifies the xml buffer parameter of a data type aciObject. |
static java.lang.String |
ACI_DATA_NODE_NAME
Specifies the node (xml tag or element) name parameter of a data type aciObject |
static java.lang.String |
ACI_DATA_NODE_VALUE
Specifies the node (xml tag or element) value parameter of a data type aciObject |
static java.lang.String |
ACI_HOSTNAME
Specifies the hostname parameter of a connection type aciObject |
static java.lang.String |
ACI_PORTNUMBER
Specifies the ACI port parameter of a connection type aciObject |
static java.lang.String |
ACI_SECURITY_DATABASE_NAMES
The "database" name parameter to pass in to setSecurityInfo when setting database information. |
static java.lang.String |
ACI_SECURITY_DATABASES
The repository parameter to pass in to setSecurityInfo when setting database information. |
static java.lang.String |
ACI_SECURITY_DOMAIN
The "domain" name parameter to pass in to setSecurityInfo when setting user access permissions. |
static java.lang.String |
ACI_SECURITY_EXTENDED
The "extended" name parameter to pass in to setSecurityInfo when setting user access permissions. |
static java.lang.String |
ACI_SECURITY_GROUP
The "group" name parameter to pass in to setSecurityInfo when setting user access permissions. |
static java.lang.String |
ACI_SECURITY_PASSWORD
The "password" name parameter to pass in to setSecurityInfo when setting user access permissions. |
static java.lang.String |
ACI_SECURITY_USERNAME
The "username" name parameter to pass in to setSecurityInfo when setting user access permissions. |
static int |
ACICONTENT_ERRORBADPARAMETER
ACI error code indicating that an incorrect or null parameter was encountered. |
static int |
ACICONTENT_ERRORNOTFOUND
ACI error code indicating that a file could not be found. |
static int |
ACICONTENT_ERRORNOTMULTIPART
ACI error code indicating an error in processing a multipart request. |
static int |
ACICONTENT_SUCCESS
ACI error code indicating no error. |
static java.lang.String |
AUTN_XML_HEADER
|
static java.lang.String |
AUTN_XML_TAIL
|
static java.lang.String |
FORCEFILENAMEDELIMITER
|
static boolean |
m_bDebug
|
Constructor Summary | |
aciObject(java.lang.Integer ioType)
|
Method Summary | |
com.autonomy.client.aciObject |
aciObjectExecute(com.autonomy.client.aciObject oCommandToExecute)
Execute a command. |
com.autonomy.client.aciObject |
aciObjectFirstEntry()
Return the first child entry from the object |
com.autonomy.client.aciObject |
aciObjectNextEntry()
Return the next entry in object |
void |
allowSlackHTTP()
Enables use of \n\n to detect the end of the response header section (as opposed to correct \r\n\r\n ) |
boolean |
checkForSuccess()
Checks whether an ACI server reply object contains a successful response entry. |
com.autonomy.client.aciObject |
duplicate(boolean bWithSiblings)
|
com.autonomy.client.aciObject |
findFirstOccurrence(java.lang.String sTag)
Finds first occurance of tag |
com.autonomy.client.aciObject |
findFirstOccurrenceFromRoot(java.lang.String sTag)
Finds first occurance of tag |
java.lang.String |
getAttribute(java.lang.String sAttribName)
Returns the value of an xml tag attribute as a String, or null if the attribute does not exist. |
java.util.Enumeration |
getAttributeNames()
Returns an Enumeration of String objects containing the names of the attributes contained in this request. |
java.lang.String |
getBuild()
|
java.lang.String |
getLastError()
Retrieve the last error message |
int |
getNumber()
Return the number of objects contained within the specific object |
int |
getRetries()
Deprecated. call paramGetInt(aciObject.ACI_CONN_TIMEOUT) on the connection object instead. |
java.lang.String |
getTagValue(java.lang.String sTagName)
Attempts to find an aciObject named sTagName and reads its aciObject.ACI_DATA_DATA parameter. |
java.lang.String |
getTagValue(java.lang.String sTagName,
java.lang.String sDefault)
Attempts to find an aciObject named sTagName and reads its aciObject.ACI_DATA_DATA parameter. |
int |
getTimeout()
Deprecated. call paramGetInt(aciObject.ACI_CONN_TIMEOUT) on the connection object instead. |
java.lang.String |
getVersion()
Return the aciObject version |
boolean |
isAlive()
Checks whether the ACI server is up and running. |
boolean |
paramGetBool(java.lang.String szName)
Retrieve the parameter from the object |
double |
paramGetDouble(java.lang.String szName)
Retrieve the parameter from the object |
int |
paramGetInt(java.lang.String szName)
Retrieve the parameter from the object |
long |
paramGetLong(java.lang.String szName)
Retrieve the parameter from the object |
java.lang.String |
paramGetString(java.lang.String szName)
Retrieve the parameter from the object |
int |
paramSetBool(java.lang.String szName,
boolean bValue)
Add a boolean parameter to the object |
int |
paramSetDouble(java.lang.String szName,
double dValue)
Add a double parameter to the object |
int |
paramSetFile(java.lang.String sName,
java.lang.String sFilename)
Adds a file for uploading via multipart encoding. |
int |
paramSetInt(java.lang.String szName,
int nValue)
Add a Int parameter to the object |
int |
paramSetLong(java.lang.String szName,
long lnValue)
Add a long parameter to the object |
int |
paramSetString(java.lang.String szName,
java.lang.String szValue)
Add a String parameter to the object |
int |
paramSetStringArray(java.lang.String szName,
java.lang.String[] aszValues)
Add an array of Strings as the value of a parameter to the object |
com.autonomy.client.aciObject |
parseResultString(java.lang.String sOrigXML)
Turns xml response from an ACI server into an aciObject (or subclass) linked list using the
an XML2ACIParser . |
void |
setRetries(int nRetries)
Deprecated. call paramSetInt(aciObject.ACI_CONN_TIMEOUT, nTimeout) on the connection object instead. |
int |
setSecurityKeys(int n1,
int n2,
int n3,
int n4)
Set the keys used for secure communications with an ACI Server. |
void |
setTimeout(int nTimeout)
Deprecated. call paramSetInt(aciObject.ACI_CONN_TIMEOUT, nTimeout) on the connection object instead. |
int |
setUserSecurityInfo(java.lang.String sRepository,
java.lang.String sName,
java.lang.String sValue)
Set an item of security information for a specific security type. |
java.lang.String |
toHTMLString()
Constructs a String representation of the linked list headed by this aciObject that can be viewed in
a web browser, detailing all parameters and attributes set on each object in the linked list. |
java.lang.String |
toString()
Constructs a String representation of the linked list headed by this aciObject, detailing all
parameters and attributes set on each object in the linked list. |
java.lang.String |
toXMLString()
Constructs an XML representation of the linked list headed by this aciObject, detailing all
parameters and attributes set on each object in the linked list. |
java.lang.String |
URLEncode(java.lang.String s)
Utility function to URLEncode a string using whatever character send encoding has been set using the ACI_CONN_SENDENCODING parameter or the platform default character encoding if this parameter has not been set. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int ACICONTENT_SUCCESS
public static final int ACICONTENT_ERRORBADPARAMETER
public static final int ACICONTENT_ERRORNOTFOUND
public static final int ACICONTENT_ERRORNOTMULTIPART
public static final int ACI_CONNECTION
public static final int ACI_COMMAND
public static final int ACI_DATA
public static final java.lang.String ACI_HOSTNAME
public static final java.lang.String ACI_PORTNUMBER
public static final java.lang.String ACI_CONN_RETRIES
public static final java.lang.String ACI_CONN_TIMEOUT
public static final java.lang.String ACI_CONN_RECVENCODING
public static final java.lang.String ACI_CONN_SENDENCODING
public static final java.lang.String ACI_COM_COMMAND
public static final java.lang.String ACI_COM_INDEX_DATA
public static final java.lang.String ACI_COM_METHOD
ACI_COM_USE_POST
,
Constant Field Valuespublic static final java.lang.String ACI_COM_USE_POST
public static final java.lang.String ACI_COM_USE_MULTIPART
public static final java.lang.String ACI_SECURITY_USERNAME
public static final java.lang.String ACI_SECURITY_PASSWORD
public static final java.lang.String ACI_SECURITY_DOMAIN
public static final java.lang.String ACI_SECURITY_GROUP
public static final java.lang.String ACI_SECURITY_EXTENDED
public static final java.lang.String ACI_SECURITY_DATABASES
public static final java.lang.String ACI_SECURITY_DATABASE_NAMES
public static final java.lang.String ACI_DATA_NODE_NAME
public static final java.lang.String ACI_DATA_NODE_VALUE
public static final java.lang.String ACI_DATA_DATA
public static final java.lang.String AUTN_XML_HEADER
public static final java.lang.String AUTN_XML_TAIL
public static final java.lang.String FORCEFILENAMEDELIMITER
public static boolean m_bDebug
Constructor Detail |
public aciObject(java.lang.Integer ioType)
Method Detail |
public boolean checkForSuccess()
public com.autonomy.client.aciObject aciObjectFirstEntry()
public com.autonomy.client.aciObject aciObjectNextEntry()
public com.autonomy.client.aciObject duplicate(boolean bWithSiblings)
public int getNumber()
public java.lang.String getAttribute(java.lang.String sAttribName)
sAttribName
- a String specifying the name of the attribute.public java.util.Enumeration getAttributeNames()
public int paramSetString(java.lang.String szName, java.lang.String szValue)
szName
- name of the parameterszValue
- value for the parameter. May be null in which case the parameter's value is set to empty string.
public int paramSetStringArray(java.lang.String szName, java.lang.String[] aszValues)
szName
- name of the parameteraszValues
- a String array of values. May be null in which case the parameter's value is set to empty string.
public int paramSetDouble(java.lang.String szName, double dValue)
szName
- name of the parameterdValue
- value for the parameter
public int paramSetInt(java.lang.String szName, int nValue)
szName
- name of the parameternValue
- value for the parameter
public int paramSetLong(java.lang.String szName, long lnValue)
szName
- name of the parameterlnValue
- value for the parameter
public int paramSetBool(java.lang.String szName, boolean bValue)
szName
- name of the parameterbValue
- value for the parameter
public int paramSetFile(java.lang.String sName, java.lang.String sFilename)
sName
- name of file parametersFilename
- fully qualified location of file on disk
public java.lang.String paramGetString(java.lang.String szName)
szName
- the name of the variable to retrieve
public int paramGetInt(java.lang.String szName)
szName
- the name of the variable to retrieve
public long paramGetLong(java.lang.String szName)
szName
- the name of the variable to retrieve
public double paramGetDouble(java.lang.String szName)
szName
- the name of the variable to retrieve
public boolean paramGetBool(java.lang.String szName)
szName
- the name of the variable to retrieve
public java.lang.String getTagValue(java.lang.String sTagName, java.lang.String sDefault)
sTagName
- the name of the xml tag whose value is required.sDefault
- a default value which the method will return if no value was found (can be null
).
public java.lang.String getTagValue(java.lang.String sTagName)
sTagName
- the name of the xml tag whose value is required.
public int setSecurityKeys(int n1, int n2, int n3, int n4)
n1
- key1n2
- key2n3
- key3n4
- key4
public int setUserSecurityInfo(java.lang.String sRepository, java.lang.String sName, java.lang.String sValue)
paramSetString("secinfo", sSecString)
.
You also use this method to set the database information for a query/suggest type action by setting sRepository to the constant value ACI_SECURITY_DATABASES, sName to ACI_SECURITY_DATABASE_NAMES and sValue to a '+' separated list of the databases the query/suggest should check against.
sRepository
- the name of the security scheme for which this information should be set. This must
correspond to one of the security types as defined in the [Security] section of the
server configuration.sName
- the name of the security parameter that is being set. This must be one of the defined
constants:
sValue
- the value of the parameter specified by sName.
public void setTimeout(int nTimeout)
nTimeout
- the time in milliseconds. A time of 0 means wait indefinitely.public int getTimeout()
public void setRetries(int nRetries)
nRetries
- the number of times a connection with the server is attempted before timing out.public int getRetries()
public java.lang.String getLastError()
public void allowSlackHTTP()
\n\n
to detect the end of the response header section (as opposed to correct \r\n\r\n
)
public com.autonomy.client.aciObject findFirstOccurrence(java.lang.String sTag)
public com.autonomy.client.aciObject findFirstOccurrenceFromRoot(java.lang.String sTag)
public com.autonomy.client.aciObject aciObjectExecute(com.autonomy.client.aciObject oCommandToExecute)
oCommandToExecute
- - The object which contains to the command to be executed
public boolean isAlive()
public com.autonomy.client.aciObject parseResultString(java.lang.String sOrigXML) throws java.lang.NullPointerException
aciObject
(or subclass) linked list using the
an XML2ACIParser
.
sOrigXML
- the string response from an ACI server
aciObject
(or subclass) objects representing the xml passed in
java.lang.NullPointerException
public java.lang.String URLEncode(java.lang.String s)
s
- the String to URL encode.
public java.lang.String getVersion()
public java.lang.String getBuild()
public java.lang.String toString()
this
aciObject, detailing all
parameters and attributes set on each object in the linked list.
toString
in class java.lang.Object
public java.lang.String toHTMLString()
this
aciObject that can be viewed in
a web browser, detailing all parameters and attributes set on each object in the linked list.
public java.lang.String toXMLString()
this
aciObject, detailing all
parameters and attributes set on each object in the linked list.
|
![]() |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |