com.tivoli.pd.jadmin
Class PDSSOResource

java.lang.Object
  com.tivoli.pd.jutil.PDEnvironmentObject
      com.tivoli.pd.jadmin.PDSSOResource

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class PDSSOResource
extends com.tivoli.pd.jutil.PDEnvironmentObject
implements java.lang.Cloneable

This class represents a single sign on (SSO) resource in the Security Access Manager policy server. An SSO resource is a third-party resource that has an authentication mechanism different from that used by Security Access Manager. In order for a Security Access Manager user to be able to access an SSO resource without re-authenticating, Security Access Manager maintains the third-party authentication information in a PDSSOCred object for that user.

Modes: Local,Remote

See Also:

Serialized Form

Constructor Summary

PDSSOResource(PDContext context, java.lang.String rName, PDMessages messages)
Creates a PDSSOResource object by retrieving the specified SSO resource data from the Security Access Manager policy server.

Method Summary

java.lang.Object	clone() Returns a copy of this object.
static void	createSSOResource(PDContext context, java.lang.String rName, java.lang.String description, PDMessages messages) Creates an SSO resource in the Security Access Manager policy server.
static void	deleteSSOResource(PDContext context, java.lang.String rName, PDMessages messages) Deletes an SSO resource from the Security Access Manager policy server.
boolean	equals(java.lang.Object obj) Determines whether this PDSSOResource object is equivalent to the input object.
java.lang.String	getDescription() Returns the SSO resource description for this object.
java.lang.String	getId() Returns the ID for this SSO resource as defined by Security Access Manager.
static java.util.ArrayList	listSSOResources(PDContext context, PDMessages messages) Lists all of the SSO resources in the Security Access Manager policy server.
java.lang.String	toString() Returns a String representation of this object.

Methods inherited from class com.tivoli.pd.jutil.PDEnvironmentObject

getContext, setContext

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDSSOResource

public PDSSOResource(PDContext context,
                     java.lang.String rName,
                     PDMessages messages)
              throws PDException

Creates a PDSSOResource object by retrieving the specified SSO resource data from the Security Access Manager policy server.

This constructor corresponds to the ivadmin_ssoweb_get() C API.

Parameters:

context - the context for communicating with the Security Access Manager policy server.

rName - the name of the SSO resource to instantiate. This value cannot be null and must have a non-zero length.

messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.

Throws:

PDException - if an error occurs. This exception may contain error and message codes defined in the product Error Message Reference document.

Method Detail

getId

public java.lang.String getId()
                       throws PDException

Returns the ID for this SSO resource as defined by Security Access Manager.

This method corresponds to the ivadmin_ssoweb_getid() C API.

Throws:

PDException

getDescription

public java.lang.String getDescription()
                                throws PDException

Returns the SSO resource description for this object. The return value will never be null, but it may be an empty String if the description has not been set.

This method corresponds to the ivadmin_ssoweb_getdescription() C API.

Throws:

PDException

toString

public java.lang.String toString()

Returns a String representation of this object.

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Returns a copy of this object.

Overrides:

clone in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Determines whether this PDSSOResource object is equivalent to the input object.

Overrides:

equals in class java.lang.Object

createSSOResource

public static void createSSOResource(PDContext context,
                                     java.lang.String rName,
                                     java.lang.String description,
                                     PDMessages messages)
                              throws PDException

Creates an SSO resource in the Security Access Manager policy server.

This constructor corresponds to the ivadmin_ssoweb_create() C API.

Parameters:

context - the context for communicating with the Security Access Manager policy server.

rName - the SSO resource name. This value cannot be null and must have a non-zero length.

description - the description of the SSO resource. This value can be null.

messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.

Throws:

PDException - if an error occurs. This exception may contain error and message codes defined in the product Error Message Reference document.

deleteSSOResource

public static void deleteSSOResource(PDContext context,
                                     java.lang.String rName,
                                     PDMessages messages)
                              throws PDException

Deletes an SSO resource from the Security Access Manager policy server.

This method corresponds to the ivadmin_ssoweb_delete() C API.

Parameters:

context - the context for communicating with the Security Access Manager policy server.

rName - the Security Access Manager SSO resource name. This value cannot be null and must have a non-zero length.

messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.

Throws:

PDException - if an error occurs. This exception may contain error and message codes defined in the product Error Message Reference document.

listSSOResources

public static java.util.ArrayList listSSOResources(PDContext context,
                                                   PDMessages messages)
                                            throws PDException

Lists all of the SSO resources in the Security Access Manager policy server. The returned list may be empty but it will never be null.

This method corresponds to the ivadmin_ssoweb_list() C API.

Parameters:

context - the context for communicating with the Security Access Manager policy server.

messages - in/out parameter; empty PDMessages on input; may contain zero or more informational or warning messages on output.

Returns:

an ArrayList of strings that represent the names of the SSO resources. The returned list will never be null.

Throws:

PDException - if an error occurs. This exception may contain error and message codes defined in the product Error Message Reference document.