Skip navigation links

oracle.search.admin.api.ws.client
Class Credentials

java.lang.Object
oracle.search.admin.api.ws.client.Credentials

public class Credentials

extends Object

Contains the administrator user name and password to use for authentication. All API operations in AdminPortType accept Credentials. See AdminPortType for a description of when administrator credentials are required.

The following schema fragment specifies the expected SOAP XML for this class:

 <complexType name="credentials">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="password" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="properties" type="{http://search.oracle.com/Admin}adminProperty" maxOccurs="unbounded" minOccurs="0"/>
         <element name="userName" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 

See Also:

AdminPortType

Constructor Summary

Credentials()

Method Summary

String	getPassword() Returns the administrator password.
List	getProperties() Returns the list of administration properties.
String	getUserName() Returns the administrator user name.
void	setPassword(String value) Sets the administrator password.
void	setUserName(String value) Sets the administrator user name.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Credentials

public Credentials()

Method Detail

getPassword

public String getPassword()

Returns the administrator password.

Returns:

The administrator password.

setPassword

public void setPassword(String value)

Sets the administrator password.

Parameters:

value - The administrator password.

getProperties

public List getProperties()

Returns the list of administration properties. To add a new property:

   getProperties().add( newProperty );
 

NOTE: Not currently used.

Returns:

A List of AdminProperty.

getUserName

public String getUserName()

Returns the administrator user name.

Returns:

The administrator user name.

setUserName

public void setUserName(String value)

Sets the administrator user name.

Parameters:

value - The administrator user name.

Skip navigation links