Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 2 (11.2.2)

Part Number E23428-01
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

getState identityPlugin

Returns the current state of an identity plug-in as an XML document.

See Also

getAllStates identityPlugin
getStateList identityPlugin

Syntax

getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=status]

or

getState identityPlugin --JAR_FILE=jar_filename --MANAGER_CLASS=class [-o output_file] [-l status]

Parameters

jar_filename

Content of a search:jarFilePath element in the XML document.

class

Content of a search:managerClassName element in the XML document.

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getState command creates a separate file for each one and appends the host name and port number to the base name.

Example

This example gets the current state of a particular identity plug-in:

SES>getState identityPlugin --JAR_FILE=OIDPlugins.jar --MANAGER_CLASS=oracle.search.plugin.security.identity.oid.OIDPluginManager
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.2.1.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>identityPlugin</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>jarFilePath</search:name>
                  <search:value>OIDPlugins.jar</search:value>
               </search:keyPair>
               <search:keyPair>
                  <search:name>managerClassName</search:name>
                  <search:value>
                  oracle.search.plugin.security.identity.oid.OIDPluginManager
                  </search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>ACTIVE</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>