netegrity.siteminder.javaagent
Class ServiceAPI

java.lang.Object
  netegrity.siteminder.javaagent.AgentAPI
      netegrity.siteminder.javaagent.ServiceAPI

public class ServiceAPI
extends AgentAPI

Provides Java access to the additional methods of SiteMinder Agent API for use in SiteMinder web services.

Since:

SiteMinder 12.5

Field Summary

static int	ATTR_SESSION_ANONYMOUS
static int	ATTR_SESSION_AUTHCONTEXT
static int	ATTR_SESSION_DIRNAME
static int	ATTR_SESSION_DIROID
static int	ATTR_SESSION_DN
static int	ATTR_SESSION_DRIFT
static int	ATTR_SESSION_ID
static int	ATTR_SESSION_IDLETIMEOUT
static int	ATTR_SESSION_IMPERSONATORDIRNAME
static int	ATTR_SESSION_IMPERSONATORNAME
static int	ATTR_SESSION_IP
static int	ATTR_SESSION_LASTTIME
static int	ATTR_SESSION_LEVEL
static int	ATTR_SESSION_LOGINNAME
static int	ATTR_SESSION_MAXTIMEOUT
static int	ATTR_SESSION_PERSISTENT
static int	ATTR_SESSION_STARTTIME
static int	ATTR_SESSION_TYPE
static int	ATTR_SESSION_UNIVID
static int	ATTR_SESSION_VERSION

Fields inherited from class netegrity.siteminder.javaagent.AgentAPI

ACCT_SERVER, AFFILIATE_KEY_UPDATE, AGENT_KEY_UPDATE_CURRENT, AGENT_KEY_UPDATE_LAST, AGENT_KEY_UPDATE_NEXT, AGENT_KEY_UPDATE_PERSISTENT, ATTR_AUTH_DIR_NAME, ATTR_AUTH_DIR_NAMESPACE, ATTR_AUTH_DIR_OID, ATTR_AUTH_DIR_SERVER, ATTR_CLIENTIP, ATTR_DEVICENAME, ATTR_IDENTITYSPEC, ATTR_IDLESESSIONTIMEOUT, ATTR_LASTSESSIONTIME, ATTR_MAXSESSIONTIMEOUT, ATTR_SERVICE_DATA, ATTR_SESSIONID, ATTR_SESSIONSPEC, ATTR_STARTSESSIONTIME, ATTR_STATUS_MESSAGE, ATTR_USERDN, ATTR_USERMSG, ATTR_USERNAME, ATTR_USERUNIVERSALID, AUTH_SERVER, AZ_SERVER, CACHE_FLUSH_ALL, CACHE_FLUSH_ALL_REALMS, CACHE_FLUSH_ALL_USERS, CACHE_FLUSH_THIS_REALM, CACHE_FLUSH_THIS_USER, CERT_HASH_SIZE, CHALLENGE, CRED_ALLOWSAVECREDS, CRED_BASIC, CRED_CERT_OR_BASIC, CRED_CERT_OR_FORM, CRED_DIGEST, CRED_FORMREQUIRED, CRED_METADATA_REQUIRED, CRED_NONE, CRED_NT_CHAL_RESP, CRED_SAML, CRED_SSLREQUIRED, CRED_X509CERT, CRED_X509CERT_ISSUERDN, CRED_X509CERT_USERDN, CRED_XML_DOCUMENT_MAPPED, CRED_XML_DSIG, CRED_XML_DSIG_XKMS, CRED_XML_WSSEC, FAILURE, INVALID_AGENTINSTANCEDEF, INVALID_ATTRLIST, INVALID_AUTHDOMAIN, INVALID_AUTHSCHEME, INVALID_MGMTCTXDEF, INVALID_REALMDEF, INVALID_RESCTXDEF, INVALID_SESSIONDEF, INVALID_SESSIONID, INVALID_TSR, INVALID_USERCREDS, NO, NOCONNECTION, SM_AGENTAPI_REQATTR_FLAGS_DELETE, SM_AGENTAPI_REQATTR_FLAGS_NONE, SM_AGENTAPI_RESPATTR_FLAGS_NONE, SM_AGENTAPI_RESPATTR_FLAGS_UNRESOLVED, SUCCESS, TIMEOUT, UNRESOLVED, VERSION_12, VERSION_12_5, VERSION_40, VERSION_50, VERSION_60, VERSION_60_FIPS, YES

Constructor Summary

ServiceAPI()

Method Summary

int	login(java.lang.String clientIpAddress, java.lang.String domain, java.lang.String scheme, java.lang.String agent, UserCredentials uc, SessionDef sd, AttributeList al) Performs service login without providing a resource.

Methods inherited from class netegrity.siteminder.javaagent.AgentAPI

audit, authorize, authorizeEx, createSSOToken, decodeSSOToken, delSessionVariables, delSessionVariablesEx, doManagement, getAgentConfig, getConfig, getMaxTransactBufSize, getMaxTunnelBufSize, getSessionVariables, getSessionVariablesEx, init, isProtected, isProtectedEx, login, loginEx, logout, logoutEx, makeCertificateHash, setAgentInstanceInfo, setSessionVariables, setSessionVariablesEx, transact, tunnel, unInit, updateAttributes, validate, validateEx

Methods inherited from class java.lang.Object

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

Field Detail

ATTR_SESSION_VERSION

public static final int ATTR_SESSION_VERSION

See Also:

Constant Field Values

ATTR_SESSION_STARTTIME

public static final int ATTR_SESSION_STARTTIME

See Also:

Constant Field Values

ATTR_SESSION_LASTTIME

public static final int ATTR_SESSION_LASTTIME

See Also:

Constant Field Values

ATTR_SESSION_MAXTIMEOUT

public static final int ATTR_SESSION_MAXTIMEOUT

See Also:

Constant Field Values

ATTR_SESSION_IDLETIMEOUT

public static final int ATTR_SESSION_IDLETIMEOUT

See Also:

Constant Field Values

ATTR_SESSION_LEVEL

public static final int ATTR_SESSION_LEVEL

See Also:

Constant Field Values

ATTR_SESSION_ID

public static final int ATTR_SESSION_ID

See Also:

Constant Field Values

ATTR_SESSION_IP

public static final int ATTR_SESSION_IP

See Also:

Constant Field Values

ATTR_SESSION_DN

public static final int ATTR_SESSION_DN

See Also:

Constant Field Values

ATTR_SESSION_DIROID

public static final int ATTR_SESSION_DIROID

See Also:

Constant Field Values

ATTR_SESSION_DIRNAME

public static final int ATTR_SESSION_DIRNAME

See Also:

Constant Field Values

ATTR_SESSION_UNIVID

public static final int ATTR_SESSION_UNIVID

See Also:

Constant Field Values

ATTR_SESSION_TYPE

public static final int ATTR_SESSION_TYPE

See Also:

Constant Field Values

ATTR_SESSION_ANONYMOUS

public static final int ATTR_SESSION_ANONYMOUS

See Also:

Constant Field Values

ATTR_SESSION_IMPERSONATORNAME

public static final int ATTR_SESSION_IMPERSONATORNAME

See Also:

Constant Field Values

ATTR_SESSION_LOGINNAME

public static final int ATTR_SESSION_LOGINNAME

See Also:

Constant Field Values

ATTR_SESSION_PERSISTENT

public static final int ATTR_SESSION_PERSISTENT

See Also:

Constant Field Values

ATTR_SESSION_DRIFT

public static final int ATTR_SESSION_DRIFT

See Also:

Constant Field Values

ATTR_SESSION_IMPERSONATORDIRNAME

public static final int ATTR_SESSION_IMPERSONATORDIRNAME

See Also:

Constant Field Values

ATTR_SESSION_AUTHCONTEXT

public static final int ATTR_SESSION_AUTHCONTEXT

See Also:

Constant Field Values

Constructor Detail

ServiceAPI

public ServiceAPI()

Method Detail

login

public int login(java.lang.String clientIpAddress,
                 java.lang.String domain,
                 java.lang.String scheme,
                 java.lang.String agent,
                 UserCredentials uc,
                 SessionDef sd,
                 AttributeList al)

Performs service login without providing a resource.

• Service login. To log into a new session, set the spec field of the SessionDef object to "". This object is passed into the login() method in parameter sd. After the login() call, the Policy Server attempts to authenticate credentials. If authentication is successful, a new session is created and returned in sd. The full session specification data will now be contained in the spec field.

• Session re-login. To log into an existing session, set the spec field of SessionDef to a valid session specification returned from the login() call that created the session. During session re-login, the Policy Server attempts to validate the session specification:
  • If the session id is specified in the id field of SessionDef, the id is validated against the session specification.
  • If the IP address is specified, it is validated against the session specification.

Use this method for login of all users and administrators except for SiteMinder administrators. For login of SiteMinder administrators, use login() in class SmApiSession of the Utilities package.

Parameters:

clientIpAddress - The IP address of the client requesting the resource.

domain - The name of the authentication domain.

scheme - The name of the authentication scheme.

agent - The name of the agent.

uc - The credentials of the user to be authenticated. Note: Unused fields in the UserCredentials object must be initialized to zero.

sd - With a return status of YES, NO, or CHALLENGE, this parameter contains the session data.

al - On return from the method, this parameter contains any response attributes, or is cleared if there are none. Valid values: ATTR_AUTH_DIR_OID
ATTR_AUTH_DIR_NAME
ATTR_AUTH_DIR_SERVER
ATTR_AUTH_DIR_NAMESPACE
ATTR_USERMSG
ATTR_USERDN
ATTR_USERUNIVERSALID

Returns:

One of these values:

• YES. The authentication was successful.
• NO. The authentication was not not successful.
• CHALLENGE. A user challenge is required.
• NOCONNECTION. The object was not connected.
• TIMEOUT. The server did not respond in the specified time.
• FAILURE. The operation failed.
• INVALID_RESCTXDEF. The Resource Context Definition is invalid.
• INVALID_REALMDEF. The Realm Definition is invalid.
• INVALID_USERCREDS. The User Credentials are invalid.
• INVALID_SESSIONDEF. The Session Definition is invalid.
• INVALID_ATTRLIST. The Attribute List is invalid.