com.netegrity.sdk.apiutil
Class SmApiResult

java.lang.Object
  com.netegrity.sdk.apiutil.SmApiResult

public class SmApiResult
extends java.lang.Object

Holds the result of the Java API request. A result consists of a result message plus a facility, severity, and status code value, as follows:

• Facility describes the origin of the result or the exception -- for example, the result might originate on the client or server. Valid values begin with FACILITY_ and are described in the Field Detail section.
• Severity describes the severity level of the result or the exception -- for example, error, informational, or warning. Valid values begin with SEVERITY_ and are described in the Field Detail section.
• Status is the status code of the result. Each facility type has its own set of status values. Status values can be duplicated across facility types but not within a facility type. You can use a facility's unique status code to distinguish a particular result from other results that might have originated from the facility.

For example, the result SERVER_EXPIRED_SESSION contains the following information:

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 9
Message : The session has expired

Each result object and its Facility/Severity/Status combination are represented by a unique value. These unique values are associated with predefined constants defined in the Field Detail section of the SmApiResult class -- for example, SERVER_EXPIRED_SESSION. To determine the Facility/Severity/Status information for a result, you can call equals() to compare the returned SmApiResult object with the result constants.

The result could also be associated with a reason code. For example, a password policy result might include a reason code of 1001, meaning that the password doesn't contain the required number of characters.

SmApiResult objects are returned in the following circumstances:

• When results are returned from the Policy Server. Result constants for server results are prefixed with SERVER_.
  
  
• When an exception is thrown in a client DMS API or Policy API application. When these exceptions are thrown, an SmApiResult object is embedded in the exception object.

Since:

SDK 2.0

Field Summary

static SmApiResult	AGENT_FAILURE Agent API failure.
static SmApiResult	AGENT_INITIALIZATION_FAILURE Agent initialization failed.
static SmApiResult	BUFFER_CREATION_FAILURE Buffer creation failure.
static SmApiResult	CLIENT_EXPORT_CONFIG_F .config file for policy data export already exists.
static SmApiResult	CLIENT_EXPORT_FILE_WRITE_ERROR Error writing data to file during policy data export.
static SmApiResult	CLIENT_EXPORT_FILENAME_F Policy data export file name not supplied.
static SmApiResult	CLIENT_EXPORT_SMDIFFILE_F .smdif file for policy data export already exists
static SmApiResult	CLIENT_IMPORT_FILE_READ_ERROR Error reading data from file during policy data import.
static SmApiResult	CLIENT_IMPORT_NO_INPUTFILE_I Input file name for policy data import not set.
static SmApiResult	CLIENT_IMPORT_OPEN_ERROR Error opening input .smdif file for policy data import.
static SmApiResult	CLIENT_INVALID_AGENTTYPE Invalid Agent Type.
static SmApiResult	CLIENT_INVALID_AGENTTYPE_ACTION Invalid action supplied for RADIUS agent
static SmApiResult	CLIENT_INVALID_AGENTTYPE_RESOURCE Invalid Resource type set for agent
static SmApiResult	CLIENT_INVALID_AGENTTYPE_SPECIFIC Invalid Agent type Specific set for agent
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_DATATYPE Invalid AgentTypeAttr DataType
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_DATATYPE_VALUE Invalid Data type values
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_ID Invalid AgentTypeAttr Identifier
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_NUMERICVALUE Invalid Numeric Value
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_RADIUSBEHAVIOR Invalid AgentTypeAttr RADIUS Behavior
static SmApiResult	CLIENT_INVALID_AGENTTYPEATTR_RADIUSTYPE Invalid AgentTypeAttr RADIUS Type
static SmApiResult	CLIENT_INVALID_AUTHDIRNAME Invalid Authentication Directory Name.
static SmApiResult	CLIENT_INVALID_AUTHVALIDATEMAP_MAPPING_TYPE Invalid authentication and validation mapping type.
static SmApiResult	CLIENT_INVALID_OID INVALID OID is passed.
static SmApiResult	CLIENT_MISSING_AUTHVALIDATEMAP_PROPERTY Missing required property for AuthValidateMap.
static SmApiResult	CLIENT_NO_AGENTTYPE No AgentType set for AgentTypeAttr
static SmApiResult	CLIENT_NOT_IMPLEMENTED SiteMinder Java API method is not implemented.
static SmApiResult	CLIENT_NULL_PARAM_ERROR Parameter can not be null.
static SmApiResult	CLIENT_SUCCESS Indicates the result is a success.
static SmApiResult	CONNECTION_TIMEOUT Connection timeout.
static SmApiResult	CORRUPT_BUFFER Tunnel buffer corrupt.
static SmApiResult	DMS_MISMATCH_ARGUMENTS Mismatched arguments in the search filter.
static int	FACILITY_APP Application API-related results originated from an application facility.
static int	FACILITY_CLIENT Client-related results originated from a client facility.
static int	FACILITY_CONNECTION API connection-related results originated from a connection facility.
static int	FACILITY_DMS DMS-related results originated from a DMS facility.
static int	FACILITY_IMS_CLIENT Client-related results originated from an IMS facility.
static int	FACILITY_IMS_SERVER Server-related results originated from an IMS facility.
static int	FACILITY_POLICY Policy-related results originated from a policy facility.
static int	FACILITY_SERVER Server-related results originated from a server facility.
static SmApiResult	INCORRECT_BUFFER_LENGTH Incorrect buffer length.
static SmApiResult	INVALID_AGENT_CONNECTION Invalid agent API connection.
static SmApiResult	INVALID_PARAMETERS Incorrect parameters passed to the API call.
static SmApiResult	NO_SERVER_CONNECTION No server connection.
static SmApiResult	POLICY_INVALID_ADDRESS Invalid IP address.
static SmApiResult	POLICY_INVALID_ADDRESS_MODE Invalid IP address mode.
static SmApiResult	POLICY_INVALID_AUTHAZ_MAP_TYPE Invalid authentication and authorization map type.
static SmApiResult	POLICY_INVALID_GROUP_TYPE Invalid group type.
static int	REASON_NONE Indicates that there is no reason associated with the result.
static SmApiResult	SERVER_ADD_MEMBER Failed to add the member to a group.
static SmApiResult	SERVER_AUTH_CHALLENGE Authentication challenge.
static SmApiResult	SERVER_AUTH_REJECT User authentication was rejected due to invalid credentials.
static SmApiResult	SERVER_BAD_ATTR_FORMAT Attribute value not formatted properly
static SmApiResult	SERVER_BAD_FORMAT Badly formatted command.
static SmApiResult	SERVER_CHANGE_PASSWORD Failed to change the user password.
static SmApiResult	SERVER_CONFIGURATION_FAILURE Unable to get server configuration.
static SmApiResult	SERVER_CREATE Failed to create directory object.
static SmApiResult	SERVER_DELETE Failed to delete the object.
static SmApiResult	SERVER_DIRECTORY_OBJECT Directory connection failed or object does not exist.
static SmApiResult	SERVER_EXCEPTION Server Exception while processing the API request.
static SmApiResult	SERVER_EXPIRED_SESSION The session in the API request has expired.
static SmApiResult	SERVER_FAILURE API request has failed.
static SmApiResult	SERVER_FETCH_DOMAIN Failed to fetch the SiteMinder domain.
static SmApiResult	SERVER_FETCH_REALM Failed to fetch the SiteMinder realm.
static SmApiResult	SERVER_FETCH_REG_SCHEME Failed to fetch the SiteMinder registration scheme.
static SmApiResult	SERVER_FETCH_USER_DIR Failed to fetch the SiteMinder user directory.
static SmApiResult	SERVER_GET_GROUPS Failed to get groups.
static SmApiResult	SERVER_GET_PROPS Failed to get object properties.
static SmApiResult	SERVER_GET_ROLES Failed to get roles.
static SmApiResult	SERVER_GET_TEMP_PASSWORD Could not generate a temporary password.
static SmApiResult	SERVER_IMEXPORT_CRYPTO_ERROR1 Policy Server-side crypto configuration error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_CRYPTO_ERROR2 Policy Server-side crypto configuration error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_CRYPTO_ERROR3 Crypto configuration error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_CRYPTO_INITIALIZE_ERROR Crypto initialization error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_FILE_ERROR File error during policy data import/export,
static SmApiResult	SERVER_IMEXPORT_INITIALIZATION_ERROR Initialization error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_INVALID_MATCH Invalid match during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_INVALID_OBJECT Invalid object during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_INVALID_OID Invalid OID during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_INVALID_PARENT Invalid parent object during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_INVALID_PROPERTY Invalid property during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_MIGRATION_CREATE_ERROR Migration object creation error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_NO_DOMAIN Wrong domain name supplied for policy data export.
static SmApiResult	SERVER_IMEXPORT_NO_IMS_DIRECTORY Wrong IMS directory name supplied for policy data export.
static SmApiResult	SERVER_IMEXPORT_NO_IMS_ENV Wrong IMS environment name supplied for policy data export.
static SmApiResult	SERVER_IMEXPORT_OBJECT_FETCH_ERROR Unable to fetch object during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_OBJECT_NOTFOUND Object not found during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_ODBS_ERROR ODBC error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_OVERWRITE_ERROR Overwrite error during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_POLICY_STORE_ERROR Error opening policy store during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_PROPERTY_ACCESS_ERROR Unable to access property during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_PROPERTY_NOTFOUND Property not found during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_READ_ERROR Error reading from file during policy data export.
static SmApiResult	SERVER_IMEXPORT_SITEMINDER_CREDENTIALS_ERROR Error authenticating Siteminder aadminstrator credentials during policy data import/export.
static SmApiResult	SERVER_IMEXPORT_UNKNOWN_ERROR Unknown error during policy data import.
static SmApiResult	SERVER_IMEXPORT_WRITE_ERROR Error reading from file during policy data import.
static SmApiResult	SERVER_INVALID_DIRECTORY Invalid user directory configuration.
static SmApiResult	SERVER_INVALID_OBJECTCLASS Invalid object class.
static SmApiResult	SERVER_INVALID_PASSWORD Password is invalid.
static SmApiResult	SERVER_INVALID_SESSION The session in the API request is invalid.
static SmApiResult	SERVER_MISMATCH Mismatch
static SmApiResult	SERVER_NO_COMMAND The API request cannot be recognized.
static SmApiResult	SERVER_NO_ITEMS_FOUND No items found.
static SmApiResult	SERVER_NO_SESSION The API request did not contain any session information.
static SmApiResult	SERVER_NOT_AUTHORIZED The user is not authorized to perform the API request.
static SmApiResult	SERVER_NOT_IMPLEMENTED The API request is not implemented.
static SmApiResult	SERVER_PASSWORDSTATE The SmDmsUserPWState object cannot be accessed correctly.
static SmApiResult	SERVER_POLICY_API Policy API error occurred during the request.
static SmApiResult	SERVER_REMOVE_MEMBER Failed to remove the member from a group.
static SmApiResult	SERVER_RESPONSE_TOO_BIG The response is too big.
static SmApiResult	SERVER_SEARCH Failed to search.
static SmApiResult	SERVER_SET_PROPS Failed to set object properties.
static SmApiResult	SERVER_TOO_MANY_ITEMS_FOUND Too many items found.
static SmApiResult	SERVER_USER_DIR_NOT_CONFIGURED User directory not configured properly.
static SmApiResult	SERVER_USER_POLICY_IN_CONSISTENT_AND_BIT_MASK Mismatched setting of AND bit between user policies of same user directory
static SmApiResult	SERVER_WORKFLOW_EXCEPTION Exception caught in the workflow library.
static SmApiResult	SERVER_WORKFLOW_INIT Could not load or initialize the workflow library.
static SmApiResult	SERVER_WORKFLOW_POSTPROCESS Error occurred during workflow post-process.
static SmApiResult	SERVER_WORKFLOW_PREPROCESS Error occurred during workflow pre-process.
static int	SEVERITY_ERROR Indicates a severity level of error.
static int	SEVERITY_INFORMATIONAL Indicates a severity level of informational.
static int	SEVERITY_SUCCESS Indicates a severity level of success.
static int	SEVERITY_WARNING Indicates a severity level of warning.
static int	SUCCESS Status code success.

Constructor Summary

SmApiResult()
Creates an API result object.

SmApiResult(int code, java.lang.String message, SmApiObject obj)
Creates an API result object from a result code, result message, and SmApiObject.

Method Summary

boolean	equals(java.lang.Object aResult) Compares the result object specified in aResult with the current result object.
SmApiObject	getDecoderObject() Internal use only.
int	getError() Gets the unique error code.
int	getFacility() Gets the facility code associated with the error.
java.lang.String	getMessage() Gets the error message associated with the error.
int	getReason() Gets the reason code of the result.
int	getSeverity() Gets the severity code associated with the error.
int	getStatus() Gets the status code in the current facility.
static int	getStatus(int returnCode) Gets the status code in the current facility.
boolean	isSuccess() If the request is successful, the method returns true.
java.lang.String	toString() Returns a string representation of the SmApiResult object in the form of a set of entries separated by the ASCII space character.

Methods inherited from class java.lang.Object

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

Field Detail

FACILITY_CONNECTION

public static final int FACILITY_CONNECTION

API connection-related results originated from a connection facility.

Value is 0x00.

See Also:

Constant Field Values

FACILITY_DMS

public static final int FACILITY_DMS

DMS-related results originated from a DMS facility.

Values is 0x01.

See Also:

Constant Field Values

FACILITY_POLICY

public static final int FACILITY_POLICY

Policy-related results originated from a policy facility.

Value is 0x02.

See Also:

Constant Field Values

FACILITY_APP

public static final int FACILITY_APP

Application API-related results originated from an application facility.

Value is 0x03.

See Also:

Constant Field Values

FACILITY_SERVER

public static final int FACILITY_SERVER

Server-related results originated from a server facility.

Value is 0x04.

See Also:

Constant Field Values

FACILITY_CLIENT

public static final int FACILITY_CLIENT

Client-related results originated from a client facility.

Value is 0x05.

See Also:

Constant Field Values

FACILITY_IMS_CLIENT

public static final int FACILITY_IMS_CLIENT

Client-related results originated from an IMS facility. (Result values defined in IMS package. This just prevents facility number collisions)

Value is 0x06.

See Also:

Constant Field Values

FACILITY_IMS_SERVER

public static final int FACILITY_IMS_SERVER

Server-related results originated from an IMS facility. (Result values defined in IMS package. This just prevents facility number collisions)

Value is 0x07.

See Also:

Constant Field Values

SEVERITY_SUCCESS

public static final int SEVERITY_SUCCESS

Indicates a severity level of success.

Value is 0x00.

See Also:

Constant Field Values

SEVERITY_INFORMATIONAL

public static final int SEVERITY_INFORMATIONAL

Indicates a severity level of informational.

Value is 0x01.

See Also:

Constant Field Values

SEVERITY_WARNING

public static final int SEVERITY_WARNING

Indicates a severity level of warning.

Value is 0x02.

See Also:

Constant Field Values

SEVERITY_ERROR

public static final int SEVERITY_ERROR

Indicates a severity level of error.

Value is 0x03.

See Also:

Constant Field Values

REASON_NONE

public static final int REASON_NONE

Indicates that there is no reason associated with the result.

Value is 0x00.

See Also:

Constant Field Values

SUCCESS

public static final int SUCCESS

Status code success. When the API request is successful, the Policy Server returns SUCCESS.

Value is 0.

See Also:

Constant Field Values

CLIENT_SUCCESS

public static final SmApiResult CLIENT_SUCCESS

Indicates the result is a success. With this result, the facility, severity, and status code are each set to 0, and the message is empty.

INVALID_AGENT_CONNECTION

public static final SmApiResult INVALID_AGENT_CONNECTION

Invalid agent API connection. This result is returned when an API request is made without a valid Agent API connection.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 1
Message : Invalid agent connection

BUFFER_CREATION_FAILURE

public static final SmApiResult BUFFER_CREATION_FAILURE

Buffer creation failure. Tunnel buffer could not be created for the API request.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 2
Message : Could not create buffer for agent transaction

INCORRECT_BUFFER_LENGTH

public static final SmApiResult INCORRECT_BUFFER_LENGTH

Incorrect buffer length. The length of the buffer received in the response is incorrect.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 3
Message : Length of returned buffer is less than zero

SERVER_CONFIGURATION_FAILURE

public static final SmApiResult SERVER_CONFIGURATION_FAILURE

Unable to get server configuration. This result is returned when the server configuration could not be read from a configuration file or a registry.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 4
Message : Unable to get server configuration

AGENT_INITIALIZATION_FAILURE

public static final SmApiResult AGENT_INITIALIZATION_FAILURE

Agent initialization failed. The agent was unable to connect to the Policy Server.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 5
Message : Agent initialization failed

NO_SERVER_CONNECTION

public static final SmApiResult NO_SERVER_CONNECTION

No server connection. The Agent API is not initialized.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 6
Message : No server connection

CONNECTION_TIMEOUT

public static final SmApiResult CONNECTION_TIMEOUT

Connection timeout. The API request timed out.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 7
Message : Connection timed out

AGENT_FAILURE

public static final SmApiResult AGENT_FAILURE

Agent API failure. The Policy Server could not be reached.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 8
Message : Tunnel Agent failure

CORRUPT_BUFFER

public static final SmApiResult CORRUPT_BUFFER

Tunnel buffer corrupt. The tunnel buffer sent on the response is corrupted.

Facility : FACILITY_CONNECTION
Severity : SEVERITY_ERROR
Status : 9
Message : Corrupt buffer

DMS_MISMATCH_ARGUMENTS

public static final SmApiResult DMS_MISMATCH_ARGUMENTS

Mismatched arguments in the search filter. This result is returned on an incorrect search filter.

Facility : FACILITY_DMS
Severity : SEVERITY_ERROR
Status : 1
Message : Mismatched arguments in the filter

POLICY_INVALID_ADDRESS_MODE

public static final SmApiResult POLICY_INVALID_ADDRESS_MODE

Invalid IP address mode.

Facility : FACILITY_POLICY
Severity : SEVERITY_ERROR
Status : 1
Message : Invalid IP Address mode

POLICY_INVALID_AUTHAZ_MAP_TYPE

public static final SmApiResult POLICY_INVALID_AUTHAZ_MAP_TYPE

Invalid authentication and authorization map type.

Facility : FACILITY_POLICY
Severity : SEVERITY_ERROR
Status : 2
Message : Invalid authentication and authorization map type

POLICY_INVALID_GROUP_TYPE

public static final SmApiResult POLICY_INVALID_GROUP_TYPE

Invalid group type.

Facility : FACILITY_POLICY
Severity : SEVERITY_ERROR
Status : 3
Message : Invalid group type

POLICY_INVALID_ADDRESS

public static final SmApiResult POLICY_INVALID_ADDRESS

Invalid IP address.

Facility : FACILITY_POLICY
Severity : SEVERITY_ERROR
Status : 4
Message : Invalid IP Address

SERVER_FAILURE

public static final SmApiResult SERVER_FAILURE

API request has failed.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 2
Message : Operation has failed

SERVER_BAD_FORMAT

public static final SmApiResult SERVER_BAD_FORMAT

Badly formatted command.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 3
Message : Badly formatted command

SERVER_RESPONSE_TOO_BIG

public static final SmApiResult SERVER_RESPONSE_TOO_BIG

The response is too big.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 4
Message : The response is too big

SERVER_NOT_IMPLEMENTED

public static final SmApiResult SERVER_NOT_IMPLEMENTED

The API request is not implemented.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 5
Message : Not implemented

SERVER_NO_COMMAND

public static final SmApiResult SERVER_NO_COMMAND

The API request cannot be recognized.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 6
Message : Unrecognized command

SERVER_EXCEPTION

public static final SmApiResult SERVER_EXCEPTION

Server Exception while processing the API request.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 7
Message : Server exception

SERVER_NO_SESSION

public static final SmApiResult SERVER_NO_SESSION

The API request did not contain any session information.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 8
Message : No session

SERVER_EXPIRED_SESSION

public static final SmApiResult SERVER_EXPIRED_SESSION

The session in the API request has expired.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 9
Message : The session has expired

SERVER_INVALID_SESSION

public static final SmApiResult SERVER_INVALID_SESSION

The session in the API request is invalid.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 10
Message : The session is invalid

SERVER_AUTH_REJECT

public static final SmApiResult SERVER_AUTH_REJECT

User authentication was rejected due to invalid credentials. The reason may contain additional information.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 11
Message : User was not authenticated

SERVER_NOT_AUTHORIZED

public static final SmApiResult SERVER_NOT_AUTHORIZED

The user is not authorized to perform the API request.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 12
Message : User is not authorized to perform this operation

SERVER_INVALID_PASSWORD

public static final SmApiResult SERVER_INVALID_PASSWORD

Password is invalid.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 13
Message : Password is invalid

SERVER_CHANGE_PASSWORD

public static final SmApiResult SERVER_CHANGE_PASSWORD

Failed to change the user password.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 14
Message : Failed to change password

SERVER_GET_TEMP_PASSWORD

public static final SmApiResult SERVER_GET_TEMP_PASSWORD

Could not generate a temporary password.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 15
Message : Could not generate temporary password

SERVER_WORKFLOW_INIT

public static final SmApiResult SERVER_WORKFLOW_INIT

Could not load or initialize the workflow library.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 16
Message : Could not load or init workflow library

SERVER_WORKFLOW_EXCEPTION

public static final SmApiResult SERVER_WORKFLOW_EXCEPTION

Exception caught in the workflow library.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 17
Message : Exception caught in the workflow library

SERVER_WORKFLOW_PREPROCESS

public static final SmApiResult SERVER_WORKFLOW_PREPROCESS

Error occurred during workflow pre-process.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 18
Message : Workflow preprocess error

SERVER_WORKFLOW_POSTPROCESS

public static final SmApiResult SERVER_WORKFLOW_POSTPROCESS

Error occurred during workflow post-process.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 19
Message : Workflow post-process error

SERVER_INVALID_OBJECTCLASS

public static final SmApiResult SERVER_INVALID_OBJECTCLASS

Invalid object class.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 20
Message : Invalid object class

SERVER_INVALID_DIRECTORY

public static final SmApiResult SERVER_INVALID_DIRECTORY

Invalid user directory configuration.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 21
Message : Invalid user directory configuration

SERVER_DIRECTORY_OBJECT

public static final SmApiResult SERVER_DIRECTORY_OBJECT

Directory connection failed or object does not exist.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 22
Message : Directory connection failed or object does not exist

SERVER_CREATE

public static final SmApiResult SERVER_CREATE

Failed to create directory object.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 23
Message : Could not create directory object

SERVER_GET_PROPS

public static final SmApiResult SERVER_GET_PROPS

Failed to get object properties.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 24
Message : Could not get object properties

SERVER_SET_PROPS

public static final SmApiResult SERVER_SET_PROPS

Failed to set object properties.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 25
Message : Could not set object properties

SERVER_GET_GROUPS

public static final SmApiResult SERVER_GET_GROUPS

Failed to get groups.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 26
Message : Could not get groups

SERVER_GET_ROLES

public static final SmApiResult SERVER_GET_ROLES

Failed to get roles.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 27
Message : Could not get roles

SERVER_ADD_MEMBER

public static final SmApiResult SERVER_ADD_MEMBER

Failed to add the member to a group.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 28
Message : Could not add member to group entity

SERVER_REMOVE_MEMBER

public static final SmApiResult SERVER_REMOVE_MEMBER

Failed to remove the member from a group.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 29
Message : Could not remove member from group entity

SERVER_SEARCH

public static final SmApiResult SERVER_SEARCH

Failed to search.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 30
Message : Search failure

SERVER_DELETE

public static final SmApiResult SERVER_DELETE

Failed to delete the object.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 31
Message : Could not delete object

SERVER_FETCH_REALM

public static final SmApiResult SERVER_FETCH_REALM

Failed to fetch the SiteMinder realm.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 32
Message : Failed to fetch SiteMinder realm

SERVER_FETCH_DOMAIN

public static final SmApiResult SERVER_FETCH_DOMAIN

Failed to fetch the SiteMinder domain.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 33
Message : Failed to fetch SiteMinder domain

SERVER_FETCH_REG_SCHEME

public static final SmApiResult SERVER_FETCH_REG_SCHEME

Failed to fetch the SiteMinder registration scheme.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 34
Message : Failed to fetch SiteMinder registration scheme

SERVER_FETCH_USER_DIR

public static final SmApiResult SERVER_FETCH_USER_DIR

Failed to fetch the SiteMinder user directory.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 35
Message : Failed to fetch SiteMinder user directory

SERVER_POLICY_API

public static final SmApiResult SERVER_POLICY_API

Policy API error occurred during the request. The reason is the Policy Api error code.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 36
Message : Policy API error

SERVER_AUTH_CHALLENGE

public static final SmApiResult SERVER_AUTH_CHALLENGE

Authentication challenge. The reason may contain additional information. The message may contain additional text.

Facility : FACILITY_SERVER
Severity : SEVERITY_WARNING
Status : 37
Message : Authentication challenge

SERVER_NO_ITEMS_FOUND

public static final SmApiResult SERVER_NO_ITEMS_FOUND

No items found. The reason may contain additional information. The message may contain additional text.

Facility : FACILITY_SERVER
Severity : SEVERITY_WARNING
Status : 38
Message : No items found

SERVER_TOO_MANY_ITEMS_FOUND

public static final SmApiResult SERVER_TOO_MANY_ITEMS_FOUND

Too many items found. The reason may contain additional information. The message may contain additional text.

Facility : FACILITY_SERVER
Severity : SEVERITY_WARNING
Status : 39
Message : Too many items found

SERVER_USER_DIR_NOT_CONFIGURED

public static final SmApiResult SERVER_USER_DIR_NOT_CONFIGURED

User directory not configured properly. Some attributes may not be defined.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 40
Message : User directory not configured

SERVER_BAD_ATTR_FORMAT

public static final SmApiResult SERVER_BAD_ATTR_FORMAT

Attribute value not formatted properly

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 41
Message : Attribute value not formatted properly

SERVER_MISMATCH

public static final SmApiResult SERVER_MISMATCH

Mismatch

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 42
Message : Mismatch

SERVER_PASSWORDSTATE

public static final SmApiResult SERVER_PASSWORDSTATE

The SmDmsUserPWState object cannot be accessed correctly.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 43
Message : PasswordState can not be accessed correctly.

Since:

SDK 6.0

SERVER_IMEXPORT_CRYPTO_ERROR1

public static final SmApiResult SERVER_IMEXPORT_CRYPTO_ERROR1

Policy Server-side crypto configuration error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 44
Message : Unable to get crypto configuration. [1]

SERVER_IMEXPORT_CRYPTO_ERROR2

public static final SmApiResult SERVER_IMEXPORT_CRYPTO_ERROR2

Policy Server-side crypto configuration error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 45
Message : Unable to get crypto configuration. [2]

SERVER_IMEXPORT_CRYPTO_ERROR3

public static final SmApiResult SERVER_IMEXPORT_CRYPTO_ERROR3

Crypto configuration error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 46
Message : Unable to get crypto configuration. [3]

SERVER_IMEXPORT_CRYPTO_INITIALIZE_ERROR

public static final SmApiResult SERVER_IMEXPORT_CRYPTO_INITIALIZE_ERROR

Crypto initialization error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 47
Message : Unable to initialize crypto factory

SERVER_IMEXPORT_POLICY_STORE_ERROR

public static final SmApiResult SERVER_IMEXPORT_POLICY_STORE_ERROR

Error opening policy store during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 48
Message : Could not open policy store

SERVER_IMEXPORT_SITEMINDER_CREDENTIALS_ERROR

public static final SmApiResult SERVER_IMEXPORT_SITEMINDER_CREDENTIALS_ERROR

Error authenticating Siteminder aadminstrator credentials during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 49
Message : Could not authenticate SiteMinder administrator. Credentials are not valid

SERVER_IMEXPORT_NO_DOMAIN

public static final SmApiResult SERVER_IMEXPORT_NO_DOMAIN

Wrong domain name supplied for policy data export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 50
Message : Could not find Passed domain

SERVER_IMEXPORT_NO_IMS_ENV

public static final SmApiResult SERVER_IMEXPORT_NO_IMS_ENV

Wrong IMS environment name supplied for policy data export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 51
Message : Could not find passed IMS environment

SERVER_IMEXPORT_NO_IMS_DIRECTORY

public static final SmApiResult SERVER_IMEXPORT_NO_IMS_DIRECTORY

Wrong IMS directory name supplied for policy data export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 52
Message : Could not find passed IMS directory

SERVER_IMEXPORT_MIGRATION_CREATE_ERROR

public static final SmApiResult SERVER_IMEXPORT_MIGRATION_CREATE_ERROR

Migration object creation error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 53
Message : Fatal Error: Failed to create a migration object

SERVER_IMEXPORT_INVALID_OBJECT

public static final SmApiResult SERVER_IMEXPORT_INVALID_OBJECT

Invalid object during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 54
Message : Fatal Error: Invalid object

SERVER_IMEXPORT_INVALID_PROPERTY

public static final SmApiResult SERVER_IMEXPORT_INVALID_PROPERTY

Invalid property during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 55
Message : Fatal Error: Invalid property

SERVER_IMEXPORT_INVALID_OID

public static final SmApiResult SERVER_IMEXPORT_INVALID_OID

Invalid OID during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 56
Message : Fatal Error: Invalid OID

SERVER_IMEXPORT_INVALID_MATCH

public static final SmApiResult SERVER_IMEXPORT_INVALID_MATCH

Invalid match during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 57
Message : Fatal Error: Invalid Match

SERVER_IMEXPORT_INVALID_PARENT

public static final SmApiResult SERVER_IMEXPORT_INVALID_PARENT

Invalid parent object during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 58
Message : Fatal Error: Invalid Parent Object

SERVER_IMEXPORT_OBJECT_NOTFOUND

public static final SmApiResult SERVER_IMEXPORT_OBJECT_NOTFOUND

Object not found during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 59
Message : Fatal Error: Object not found

SERVER_IMEXPORT_PROPERTY_NOTFOUND

public static final SmApiResult SERVER_IMEXPORT_PROPERTY_NOTFOUND

Property not found during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 60
Message : Fatal Error: Property not found

SERVER_IMEXPORT_OBJECT_FETCH_ERROR

public static final SmApiResult SERVER_IMEXPORT_OBJECT_FETCH_ERROR

Unable to fetch object during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 61
Message : Fatal Error: Unable to fetch object

SERVER_IMEXPORT_PROPERTY_ACCESS_ERROR

public static final SmApiResult SERVER_IMEXPORT_PROPERTY_ACCESS_ERROR

Unable to access property during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 62
Message : Fatal Error: Unable to access property

SERVER_IMEXPORT_OVERWRITE_ERROR

public static final SmApiResult SERVER_IMEXPORT_OVERWRITE_ERROR

Overwrite error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 63
Message : Fatal Error: Cannot overwrite

SERVER_IMEXPORT_ODBS_ERROR

public static final SmApiResult SERVER_IMEXPORT_ODBS_ERROR

ODBC error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 64
Message : Fatal Error: ODBC error

SERVER_IMEXPORT_INITIALIZATION_ERROR

public static final SmApiResult SERVER_IMEXPORT_INITIALIZATION_ERROR

Initialization error during policy data import/export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 65
Message : Fatal Error: Failed initialization

SERVER_IMEXPORT_FILE_ERROR

public static final SmApiResult SERVER_IMEXPORT_FILE_ERROR

File error during policy data import/export,

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 66
Message : Fatal Error: File error

SERVER_IMEXPORT_UNKNOWN_ERROR

public static final SmApiResult SERVER_IMEXPORT_UNKNOWN_ERROR

Unknown error during policy data import.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 67
Message : Fatal Error: Unknown error

SERVER_IMEXPORT_WRITE_ERROR

public static final SmApiResult SERVER_IMEXPORT_WRITE_ERROR

Error reading from file during policy data import.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 68
Message : Could not write to file while import

SERVER_IMEXPORT_READ_ERROR

public static final SmApiResult SERVER_IMEXPORT_READ_ERROR

Error reading from file during policy data export.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 69
Message : Could not read from file while export

SERVER_USER_POLICY_IN_CONSISTENT_AND_BIT_MASK

public static final SmApiResult SERVER_USER_POLICY_IN_CONSISTENT_AND_BIT_MASK

Mismatched setting of AND bit between user policies of same user directory

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 70
Message : Mismatched setting of AND bit between user policies of same user directory

CLIENT_NULL_PARAM_ERROR

public static final SmApiResult CLIENT_NULL_PARAM_ERROR

Parameter can not be null.

Facility : FACILITY_SERVER
Severity : SEVERITY_ERROR
Status : 71
Message : Parameter can not be null.

CLIENT_NOT_IMPLEMENTED

public static final SmApiResult CLIENT_NOT_IMPLEMENTED

SiteMinder Java API method is not implemented.

Facility : FACILITY_CLIENT
Severity : SEVERITY_INFORMATIONAL
Status : 1
Message : Not implemented

CLIENT_EXPORT_FILENAME_F

public static final SmApiResult CLIENT_EXPORT_FILENAME_F

Policy data export file name not supplied.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 2
Message : Export Status: Overwrite option is specified, still no file name is set.

CLIENT_EXPORT_SMDIFFILE_F

public static final SmApiResult CLIENT_EXPORT_SMDIFFILE_F

.smdif file for policy data export already exists

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 3
Message : Export Status: smdif file already exists. Use overwrite option, while setting the file name.

CLIENT_EXPORT_CONFIG_F

public static final SmApiResult CLIENT_EXPORT_CONFIG_F

.config file for policy data export already exists.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 4
Message : Export Status: config file already exists. Use overwrite option, while setting the file name.

CLIENT_IMPORT_NO_INPUTFILE_I

public static final SmApiResult CLIENT_IMPORT_NO_INPUTFILE_I

Input file name for policy data import not set.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 5
Message : Import Status: no input filename is set.

CLIENT_IMPORT_OPEN_ERROR

public static final SmApiResult CLIENT_IMPORT_OPEN_ERROR

Error opening input .smdif file for policy data import.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 6
Message : Import Status: Unable to open set smdif file.

CLIENT_EXPORT_FILE_WRITE_ERROR

public static final SmApiResult CLIENT_EXPORT_FILE_WRITE_ERROR

Error writing data to file during policy data export.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 7
Message : Error in writing data to the file.

CLIENT_IMPORT_FILE_READ_ERROR

public static final SmApiResult CLIENT_IMPORT_FILE_READ_ERROR

Error reading data from file during policy data import.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 8
Message : Error in reading data from the file.

INVALID_PARAMETERS

public static final SmApiResult INVALID_PARAMETERS

Incorrect parameters passed to the API call.

Facility : FACILITY_APP
Severity : SEVERITY_ERROR
Status : 1
Message : Incorrect parameters passed to the API call.

CLIENT_INVALID_AGENTTYPE_ACTION

public static final SmApiResult CLIENT_INVALID_AGENTTYPE_ACTION

Invalid action supplied for RADIUS agent

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 9
Message : Only Authenticate Action allowed for RADIUS agent.

CLIENT_INVALID_AGENTTYPE_RESOURCE

public static final SmApiResult CLIENT_INVALID_AGENTTYPE_RESOURCE

Invalid Resource type set for agent

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 10
Message : Invalid Resource type set for agent.

CLIENT_INVALID_AGENTTYPE_SPECIFIC

public static final SmApiResult CLIENT_INVALID_AGENTTYPE_SPECIFIC

Invalid Agent type Specific set for agent

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 11
Message : Invalid Agent type Specific type set for agent.

CLIENT_NO_AGENTTYPE

public static final SmApiResult CLIENT_NO_AGENTTYPE

No AgentType set for AgentTypeAttr

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 12
Message : No AgentType set for AgentTypeAttr.

CLIENT_INVALID_AGENTTYPEATTR_ID

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_ID

Invalid AgentTypeAttr Identifier

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 13
Message : AgentTypeAttr Identifier should be between 0 to 255.

CLIENT_INVALID_AGENTTYPEATTR_DATATYPE

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_DATATYPE

Invalid AgentTypeAttr DataType

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 14
Message : Invalid AgentTypeAttr DataType.

CLIENT_INVALID_AGENTTYPEATTR_RADIUSTYPE

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_RADIUSTYPE

Invalid AgentTypeAttr RADIUS Type

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 15
Message : Invalid AgentTypeAttr RADIUS Type.

CLIENT_INVALID_AGENTTYPEATTR_RADIUSBEHAVIOR

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_RADIUSBEHAVIOR

Invalid AgentTypeAttr RADIUS Behavior

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 16
Message : Invalid AgentTypeAttr RADIUS Behavior.

CLIENT_INVALID_AGENTTYPEATTR_DATATYPE_VALUE

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_DATATYPE_VALUE

Invalid Data type values

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 17
Message : Values allowed only for number data type.

CLIENT_INVALID_AGENTTYPEATTR_NUMERICVALUE

public static final SmApiResult CLIENT_INVALID_AGENTTYPEATTR_NUMERICVALUE

Invalid Numeric Value

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 18
Message : Invalid Numeric Value.

CLIENT_INVALID_AUTHVALIDATEMAP_MAPPING_TYPE

public static final SmApiResult CLIENT_INVALID_AUTHVALIDATEMAP_MAPPING_TYPE

Invalid authentication and validation mapping type.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 19
Message : Invalid authentication and validation mapping type

CLIENT_MISSING_AUTHVALIDATEMAP_PROPERTY

public static final SmApiResult CLIENT_MISSING_AUTHVALIDATEMAP_PROPERTY

Missing required property for AuthValidateMap.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 20
Message : Missing required property for AuthValidateMap

CLIENT_INVALID_AUTHDIRNAME

public static final SmApiResult CLIENT_INVALID_AUTHDIRNAME

Invalid Authentication Directory Name.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 21
Message :Invalid Authentication Directory Name.

CLIENT_INVALID_AGENTTYPE

public static final SmApiResult CLIENT_INVALID_AGENTTYPE

Invalid Agent Type.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 22
Message :Invalid Agent Type.

CLIENT_INVALID_OID

public static final SmApiResult CLIENT_INVALID_OID

INVALID OID is passed.

Facility : FACILITY_CLIENT
Severity : SEVERITY_ERROR
Status : 23
Message : Invalid OID

Constructor Detail

SmApiResult

public SmApiResult()

Creates an API result object.

SmApiResult

public SmApiResult(int code,
                   java.lang.String message,
                   SmApiObject obj)

Creates an API result object from a result code, result message, and SmApiObject.

Parameters:

code - Result code coming from the server.

message - Error message associated with the result.

obj - SmApiObject containing response of a request.

Method Detail

isSuccess

public boolean isSuccess()

If the request is successful, the method returns true. Otherwise false.

Returns:

Whether a result is successful.

equals

public boolean equals(java.lang.Object aResult)

Compares the result object specified in aResult with the current result object.

Result objects contain a unique value that is associated with a predefined result constant defined in the SmApiResult class. By passing a result constant in the aResult parameter, you can compare the associated result object with the current result object.

In the following example, the result represented by the unique constant SERVER_INVALID_PASSWORD is compared against the current result object result:

    InetAddress address = InetAddress.getLocalHost();
    SmApiResult result = apiSession.login(usr,pwd,address,0);
    boolean resultStatus = result.equals(SmApiResult.SERVER_INVALID_PASSWORD);

Overrides:

equals in class java.lang.Object

Parameters:

aResult - A result object to compare against the current SmApiResult object.

Returns:

true if the two result objects match. Otherwise false.

getReason

public int getReason()

Gets the reason code of the result. For example, you could use this method to retrieve a reason code for an administrator login failure , a change password failure , or a Policy API method error.

getStatus

public int getStatus()

Gets the status code in the current facility.

Returns:

Status code of the API result.

getError

public int getError()

Gets the unique error code.

Returns:

Error code of the API result.

getFacility

public int getFacility()

Gets the facility code associated with the error.

Returns:

Facility code of the API result.

getSeverity

public int getSeverity()

Gets the severity code associated with the error.

Returns:

Severity code of the API result.

getMessage

public java.lang.String getMessage()

Gets the error message associated with the error.

Returns:

Message code of the API result.

getStatus

public static int getStatus(int returnCode)

Gets the status code in the current facility.

Parameters:

returnCode - Result code coming from the server.

Returns:

The status code of the API result.

getDecoderObject

public SmApiObject getDecoderObject()

Internal use only.

Returns an SmApiObject object containing the response of a request.

Returns:

An SmApiObject object.

toString

public java.lang.String toString()

Returns a string representation of the SmApiResult object in the form of a set of entries separated by the ASCII space character. The entire set of entries is enclosed in braces ( [ ] ).

The format is as follows:

[facility=facility severity=severity reason=reason status=statusCode message=message]

For information on interpreting the result string, see the CA eTrust Developer's Guide for Java.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of the SmApiResult object.