|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AdminPortType
A client interface to the Administration API Web Service operations. See AdminService
for an example of obtaining an AdminPortType
from an AdminService
.
There are two modes of an AdminPortType
: stateless and stateful. In stateless mode, the administrative user name and password are provided for each operation. Use this mode to avoid maintaining open HTTP connections when, for example, use of the client is sporadic.
In stateful mode, the administrative user name and password are provided at the beginning and retained for all subsequent operations, while the client maintains the HTTP session. Use this mode when executing a sequence of operations to achieve the best performance. You can provide credentials in any operation, but typically the login
operation should be called first, and then credentials can be omitted in subsequent operations.
By default, an AdminPortType
is stateless. The code below enables stateful mode:
((javax.xml.ws.BindingProvider)adminPort).getRequestContext().put( javax.xml.ws.BindingProviderr.SESSION_MAINTAIN_PROPERTY, true );
The following example creates a Web source using a stateless client:
String webSourceXML = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>" + "<search:config productVersion=\"11.1.2.0.0\" xmlns:search=\"http://xmlns.oracle.com/search\">" + " <search:sources>" + " <search:webSource>" + " <search:name>web1</search:name>" + " <search:startingUrls>" + " <search:startingUrl>" + " <search:url>http://host:port</search:url>" + " </search:startingUrl>" + " </search:startingUrls>" + " </search:webSource>" + " </search:sources>" + "</search:config>"; // Get stateless AdminPortType for the Web service URL AdminPortType adminPort = getStatelessWebServiceClient( webServiceURL ); // Create Credentials argument Credentials credentials = new Credentials(); credentials.setUserName( userName ); credentials.setPassword( password ); // Invoke createAll operation to create all sources in the input XML adminPort.createAll( "source", // object type webSourceXML, // object XML myEncryptKey, // encryption key credentials, // administrator credentials null, // no attachments null, // no operation controls "en" // error message locale );
AdminService
Method Summary | |
---|---|
void |
activate(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Activates an administrative object. |
void |
create(String creatableType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Creates an administrative object from an XML description. |
List |
createAll(String creatableType, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Creates all administrative objects with a specified type from an XML description. |
void |
deactivate(String objectType, ObjectKey objectKey, Credentials credentials, List controls, String locale) Deactivates an administrative object. |
void |
delete(String creatableType, ObjectKey objectKey, Credentials credentials, List controls, String locale) Deletes an administrative object. |
List |
deleteAll(String creatableType, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) Deletes all administrative objects with a specified type. |
List |
deleteList(String creatableType, List objectKeys, Credentials credentials, List controls, String locale) Deletes a list of administrative objects with a specified type. |
ObjectOutput |
export(String objectType, ObjectKey objectKey, String encryptionKey, Credentials credentials, List controls, String locale) Returns the configuration of an administrative object. |
ObjectOutput |
exportAll(String creatableType, ObjectKey objectKeyPattern, String encryptionKey, Credentials credentials, List controls, String locale) Returns the configuration of all administrative objects with a specified type. |
ObjectOutput |
exportList(String creatableType, List objectKeys, String encryptionKey, Credentials credentials, List controls, String locale) Returns the configuration of a list of administrative objects with a specified type. |
List |
getAllObjectKeys(String creatableType, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) Returns the object keys for all existing objects with a specified type. |
ObjectOutput |
getAllStates(String creatableType, List stateProperties, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) Returns the state of all administrative objects with a specified type. |
String |
getAPIVersion(Credentials credentials, List controls, String locale) Returns the version number of the Administration API. |
ObjectOutput |
getState(String objectType, ObjectKey objectKey, List stateProperties, Credentials credentials, List controls, String locale) Returns the state of an administrative object. |
ObjectOutput |
getStateList(String creatableType, List objectKeys, List stateProperties, Credentials credentials, List controls, String locale) Returns the state of a list of administrative objects with a specified type. |
void |
login(Credentials credentials, String locale) Provides the administrative credentials for a stateful session. |
void |
logout() Closes a stateful session. |
void |
start(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Starts an administrative object. |
void |
stop(String objectType, ObjectKey objectKey, Credentials credentials, List controls, String locale) Stops an administrative object. |
void |
update(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Updates an administrative object from an XML description. |
List |
updateAll(String creatableType, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) Updates all administrative objects with a specified type from an XML description. |
Method Detail |
---|
void activate(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to activate. It must be a stateful type.objectKey
- The ObjectKey
of the object to activate. Required only when objectType
is creatable. Specify null
when objectType
is universal.objectXML
- An XML description of the object to activate. Specify null
if no object description is required for the object type.decryptionKey
- The key to decrypt values that are encrypted in objectXML
. The decryption key must be at least 8 characters long, must contain only ASCII characters, and must contain both letters and numbers. Specify null
if objectType
does not require a decryption key for this operation. Specify any valid decryption key if objectXML
does not contain any encrypted values, but the objectType
does require a decryption key, for example, if all password fields are specified in clear text form. Otherwise, specify the same key that was used to encrypt the encrypted values, such as the key that used in the export
operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments. Not currently used for this operation.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid create(String creatableType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception
creatableType
- The type of object to create. It must be a creatable type.objectKey
- The ObjectKey
of the object to create.objectXML
- An XML description of the object to create.decryptionKey
- The key to decrypt values that are encrypted in objectXML
. The decryption key must be at least 8 characters long, must contain only ASCII characters, and must contain both letters and numbers. Specify null
if creatableType
does not require a decryption key for this operation. Specify any valid decryption key if objectXML
does not contain any encrypted values, but the creatableType
does require a decryption key, for example, if all password fields are specified in clear text form. Otherwise, specify the same key that was used to encrypt the encrypted values, such as the key that used in the export
operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursList createAll(String creatableType, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to create. It must be a creatable type.objectXML
- An XML description of the objects to create.decryptionKey
- The key to decrypt values that are encrypted in objectXML
. The decryption key must be at least 8 characters long, must contain only ASCII characters, and must contain both letters and numbers. Specify null
if creatableType
does not require a decryption key for this operation. Specify any valid decryption key if objectXML
does not contain any encrypted values, but the creatableType
does require a decryption key, for example, if all password fields are specified in clear text form. Otherwise, specify the same key that was used to encrypt the encrypted values, such as the key that used in the export
operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments.controls
- A List
of OperationControl
. Supported control names are: DUPE_METHOD and IGNORE_INVALID_STATE. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.Status
for each object that was processed by the operation. An empty List
if no objects with type creatableType
are contained in objectXML
.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid deactivate(String objectType, ObjectKey objectKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to deactivate. It must be a stateful type.objectKey
- The ObjectKey
of the object to deactivate. Required only when objectType
is creatable. Specify null
when objectType
is universal.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid delete(String creatableType, ObjectKey objectKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Excep
creatableType
- The type of object to delete. It must be a creatable type.objectKey
- The ObjectKey
of the object to delete.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursInvalidStateFault_Excep
List deleteAll(String creatableType, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to delete. It must be a creatable type.objectKeyPattern
- An ObjectKey
to use as a pattern. Only objects that match the object key pattern are processed. Specify null
to process all objects. See ObjectKey
for pattern syntax.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Supported control names are: IGNORE_INVALID_STATE. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.Status
for each object that was processed by the operation. An empty List
if no objects with type creatableType
are defined or no objects with type creatableType
match objectKeyPattern
.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursList deleteList(String creatableType, List objectKeys, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to delete. It must be a creatable type.objectKeys
- A List
of ObjectKey
of the objects to delete.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
Supported control names are: IGNORE_INVALID_STATE and IGNORE_NOT_FOUND. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.Status
for each object that was processed by the operation. Never returns an empty List
because objectKeys
must be non-empty.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursObjectOutput export(String objectType, ObjectKey objectKey, String encryptionKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to export.objectKey
- The ObjectKey
of the object to export. Required only when objectType
is creatable. Specify null
when objectType
is universal.encryptionKey
- The key to use to encrypt sensitive values in the XML, such as password fields. The encryption key must be at least 8 characters long, must contain only ASCII characters and must contain both letters and numbers. Specify null
if objectType
does not require an encryption key for this operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
representing the configuration of the object.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursObjectOutput exportAll(String creatableType, ObjectKey objectKeyPattern, String encryptionKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to export. It must be a creatable type.objectKeyPattern
- An ObjectKey
to use as a pattern. Only objects that match the object key pattern are processed. Specify null
to process all objects. See ObjectKey
for pattern syntax.encryptionKey
- The key to use to encrypt sensitive values in the XML, such as password fields. The encryption key must be at least 8 characters long, must contain only ASCII characters and must contain both letters and numbers. Specify null
if creatableType
does not require an encryption key for this operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
representing the configuration of the objects.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursObjectOutput exportList(String creatableType, List objectKeys, String encryptionKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to export. It must be a creatable type.objectKeys
- A List
of ObjectKey
of the objects to export.encryptionKey
- The key to use to encrypt sensitive values in the XML, such as password fields. The encryption key must be at least 8 characters long, must contain only ASCII characters and must contain both letters and numbers. Specify null
if creatableType
does not require an encryption key for this operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
Supported control names are: IGNORE_NOT_FOUND. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
representing the configuration of the objects.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursString getAPIVersion(Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, InvalidInputFault_Exception
credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursInvalidInputFault_Exception
- If an input error occursList getAllObjectKeys(String creatableType, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, InvalidInputFault_Exception
creatableType
- The type of objects whose object keys are returnd. It must be a creatable type.objectKeyPattern
- An ObjectKey
to use as a pattern. Only objects that match the object key pattern are processed. Specify null
to process all objects. See ObjectKey
for pattern syntax.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.List
of ObjectKey
. An empty List
if no objects with type creatableType
are defined or no objects with type creatableType
match objectKeyPattern
.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursInvalidInputFault_Exception
- If an input error occursObjectOutput getAllStates(String creatableType, List stateProperties, ObjectKey objectKeyPattern, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects whose state is returned. It must be a creatable and stateful type.stateProperties
- A List
of String
state property names to include in the object states. Specify null
to return all state properties.objectKeyPattern
- An ObjectKey
to use as a pattern. Only objects that match the object key pattern are processed. Specify null
to process all objects. See ObjectKey
for pattern syntax.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
containing an XML description of the object states.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursObjectOutput getState(String objectType, ObjectKey objectKey, List stateProperties, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object whose state is returned. It must be a stateful type.objectKey
- The ObjectKey
of the object. Required only when objectType
is creatable. Specify null
when objectType
is universal.stateProperties
- A List
of String
state property names to include in the object state. Specify null
to return all state properties.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
containing an XML description of the object state.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursObjectOutput getStateList(String creatableType, List objectKeys, List stateProperties, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects whose state is returned. It must be a creatable and stateful type.objectKeys
- A List
of ObjectKey
of the objects.stateProperties
- A List
of String
state property names to include in the object states. Specify null
to return all state properties.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
Supported control names are: IGNORE_NOT_FOUND. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.ObjectOutput
containing an XML description of the object states.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid login(Credentials credentials, String locale) throws AdminAPIRuntimeFault_Exception
logout
operation is called.credentials
- The administrator credentials.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursvoid logout() throws AdminAPIRuntimeFault_Exception
AdminAPIRuntimeFault_Exception
- If an unexpected error occursvoid start(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to start. it must be a stateful type.objectKey
- The ObjectKey
of the object to start. Required only when objectType
is creatable. Specify null
when objectType
is universal.objectXML
- An XML description of the object to start. Not currently used for this operation.decryptionKey
- The key used to decrypt values that are encrypted in objectXML
. Not currently used for this operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments. Not currently used for this operation.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid stop(String objectType, ObjectKey objectKey, Credentials credentials, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to stop. It must be a stateful type.objectKey
- The ObjectKey
of the object to stop. Required only when objectType
is creatable. Specify null
when objectType
is universal.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.controls
- A List
of OperationControl
. Not currently used for this operation.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursvoid update(String objectType, ObjectKey objectKey, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
objectType
- The type of object to update.objectKey
- The ObjectKey
of the object to update. Required only when objectType
is creatable. Specify null
when objectType
is universal.objectXML
- An XML description of the object to update.decryptionKey
- The key to decrypt values that are encrypted in objectXML
. The decryption key must be at least 8 characters long, must contain only ASCII characters, and must contain both letters and numbers. Specify null
if objectType
does not require a decryption key for this operation. Specify any valid decryption key if objectXML
does not contain any encrypted values, but the objectType
does require a decryption key, for example, if all password fields are specified in clear text form. Otherwise, specify the same key that was used to encrypt the encrypted values, such as the key that used in the export
operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments.controls
- A List
of OperationControl
Supported control names are: UPDATE_METHOD. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occursList updateAll(String creatableType, String objectXML, String decryptionKey, Credentials credentials, List attachments, List controls, String locale) throws AdminAPIRuntimeFault_Exception, CreatableAdminObjectFault_Exception, DependentObjectFault_Exception, InvalidInputFault_Exception, InvalidStateFault_Exception
creatableType
- The type of objects to update. It must be a creatable type.objectXML
- An XML description of the objects to update.decryptionKey
- The key to decrypt values that are encrypted in objectXML
. The decryption key must be at least 8 characters long, must contain only ASCII characters, and must contain both letters and numbers. Specify null
if creatableType
does not require a decryption key for this operation. Specify any valid decryption key if objectXML
does not contain any encrypted values, but the creatableType
does require a decryption key, for example, if all password fields are specified in clear text form. Otherwise, specify the same key that was used to encrypt the encrypted values, such as the key that used in the export
operation.credentials
- The administrator credentials. Specify this argument if the client is used in stateless mode, or if this is the first operation in a series of stateful operations and login
has not been called.attachments
- A List
of binary attachments.controls
- A List
of OperationControl
Supported control names are: IGNORE_INVALID_STATE, NOT_FOUND_METHOD, and UPDATE_METHOD. See OperationControl
for control descriptions.locale
- The two-letter language code of the product language to use for error messages. The default language of the Oracle SES server is used if an unsupported language or null
is specified.Status
for each object that was processed by the operation. An empty List
if no objects with type creatableType
are contained in objectXML
.AdminAPIRuntimeFault_Exception
- If an unexpected error occursCreatableAdminObjectFault_Exception
- If an error that only applies to creatable objects occursDependentObjectFault_Exception
- If an error relating to a dependent object occursInvalidInputFault_Exception
- If an input error occursInvalidStateFault_Exception
- If an error relating to an object state occurs
|
Oracle Secure Enterprise Search Java API Reference 11g Release 1 (11.1.2.0.0) E14433-02 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |