Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

exportList

Returns the XML descriptions of a list of objects of a specified type.

See Also

export, exportAll

SOAP Message

<exportList xmlns="http://search.oracle.com/Admin">
   <creatableType xmlns="">
   <objectKeys xmlns="">
      <adminKeyPairs>
         <keyName>
         <keyValue>
   <encryptionKey xmlns="">
   <credentials xmlns="">
      <password>
      <userName>
   <controls xmlns="">
      <controlName>
      <controlValue>
   <locale xmlns="">

Element Descriptions 

<exportList xmlns="http://search.oracle.com/Admin">

Describes a list of objects for export. It contains these elements:

<creatableType>
<objectKeys>
<encryptionKey>
<credentials>
<controls>
<locale>
<creatableType xmlns="">

Contains a creatable object type:

alert
altWord
clusterTree
identityPlugin
proxyLogin
schedule
searchAttr
skinBundle
source
sourceGroup
sourceType
storageArea
suggLink
<objectKeys xmlns="">

Describes the key for an object. One or more <objectKeys> elements compose the list of objects to export. This element contains one or more <adminKeyPairs> elements.

<adminKeyPairs>

Contains these elements:

<keyName>
<keyValue>
<keyName>

Contains the case-sensitive key name of the object type, such as name.

<keyValue>

Contains the value that uniquely describes the object, such as "Website Schedule".

<encryptionKey xmlns="">

The encryption key for passwords in the XML description of identityPlugin, proxyLogin, and source objects. The key must be at least eight ASCII characters long and include at least one letter and one number. Multibyte characters are invalid.

<credentials xmlns="">

Provides the credentials for the Oracle SES administrator. Credentials are required only when the session is stateless. See "Providing Credentials".

This element contains these child elements:

<password>
<userName>
<password>

Contains the password for <userName>.

<userName>

Contains the user name of the Oracle SES administrator.

<controls xmlns="">

Describes an operation control. It contains these elements:

<controlName>
<controlValue>
<controlName>

IGNORE_NOT_FOUND: Controls the resulting action when an object in the list does not exist.

<controlValue>

For IGNORE_NOT_FOUND:

  • true: The object is skipped and processing continues.

  • false: Processing stops with an error. (Default)

<locale xmlns="">

Sets the language for error messages. See Table 2-2, "Product Languages" for a list of valid codes.

If you omit this element or enter an invalid code, then Oracle SES uses the default locale of the system where it is running.

SOAP Faults

AdminAPIRuntimeFault
CreatableAdminObjectFault
DependentObjectFault
InvalidInputFault
InvalidStateFault

Example

This example requests the XML descriptions of three proxy log-ins: this_proxy, some_proxy, and that_proxy.

<exportList xmlns="http://search.oracle.com/Admin">
  <creatableType xmlns="">proxyLogin</creatableType>
   <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>this_proxy</keyValue>
    </adminKeyPairs>
   </objectKeys>
  <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>some_proxy</keyValue>
    </adminKeyPairs>
   </objectKeys>
   <objectKeys xmlns="">
    <adminKeyPairs>
      <keyName>name</keyName>
      <keyValue>that_proxy</keyValue>
    </adminKeyPairs>
  </objectKeys>
  <encryptionKey xmlns="">key2encrypt</encryptionKey>
   <controls xmlns="">
    <controlName>IGNORE_NOT_FOUND</controlName>
    <controlValue>true</controlValue>
  </controls> 
</exportList>

The following response provides the XML descriptions of this_proxy and that_proxy. It ignored the request for some_proxy, which did not exist.

<ns2:exportListResponse xmlns:ns2="http://search.oracle.com/Admin">
  <objectOutput>
    <objectXML><?xml version="1.0" encoding="UTF-8"?>
    <search:config productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
      <search:proxyLogins>
        <search:proxyLogin>
          <search:name>this_proxy</search:name>
          <search:password encrypted="true">128b6b43...</search:password>
          <search:useIdentityPlugin>false</search:useIdentityPlugin>
        </search:proxyLogin>
        <search:proxyLogin>
          <search:name>that_proxy</search:name>
          <search:password encrypted="true">a625ca28...</search:password>
          <search:useIdentityPlugin>false</search:useIdentityPlugin>
        </search:proxyLogin>
      </search:proxyLogins>
    </search:config>
    </objectXML>
  </objectOutput>
</ns2:exportListResponse>