oracle.wsm.common.sdk

Class WSMException

java.lang.Object

java.lang.Throwable

java.lang.Exception

oracle.wsm.common.exception.BaseException

oracle.wsm.common.sdk.WSMException

All Implemented Interfaces:

java.io.Serializable, oracle.wsm.resources.enforcement.EnforcementMessageID

public class WSMException
extends oracle.wsm.common.exception.BaseException
implements oracle.wsm.resources.enforcement.EnforcementMessageID

This is a new Exception class for handling OWSM Fault 11g code should create Fault using this WSMException class instead of the original com.cfluent.poicysteps.sdk.Fault

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static javax.xml.namespace.QName	FAULTCODE_QNAME_FAILED_AUTHENTICATION
static javax.xml.namespace.QName	FAULTCODE_QNAME_FAILED_CHECK
static javax.xml.namespace.QName	FAULTCODE_QNAME_GENERIC
static javax.xml.namespace.QName	FAULTCODE_QNAME_INVALID_SECURITY
static javax.xml.namespace.QName	FAULTCODE_QNAME_INVALID_SECURITY_TOKEN
static javax.xml.namespace.QName	FAULTCODE_QNAME_SECURITY_TOKEN_UNAVAILABLE
static javax.xml.namespace.QName	FAULTCODE_QNAME_SOAP_MUST_UNDERSTAND_HEADER
static javax.xml.namespace.QName	FAULTCODE_QNAME_UNSUPPORTED_TOKEN
static java.lang.String	NS_POLICY_ENFORCEMENT
static java.lang.String	NS_PREFIX
static java.lang.String	NS_SECURITY

Fields inherited from class oracle.wsm.common.exception.BaseException

m_arguments, m_bundleType, m_errorCode

Fields inherited from interface oracle.wsm.resources.enforcement.EnforcementMessageID

ACTUAL_RESOURCE_NAME_NOT_AVAILABLE_IN_MSGCTX, ADVERTISEMENT_ENGINE_INVALID_POLICYSET, AGENT_INIT_MONITOR_FAILURE, AGENT_NOT_INITIALIZED, AGENT_NOT_INITIALIZED_INVALID_PROPERTIES, AGENT_RUNTIMEEXCEPTION, ASSERTION_EXECUTION_FAILED, ATTACHTO_INCOMPATIBLE, BINDINGWS_PORT_INVALID, CANNOT_ENFORCE_DUETO_VALIDATIONERRORS, ENFORCEMENT_AUDITOR_INIT_FAILURE, ENFORCEMENT_AUDITOR_LOG_FAILURE, ENFORCEMENT_AUDITOR_NULL_ARGS, ENFORCEMENT_AUDITOR_SHUTDOWN_FAILURE, EVENT_SUCCEEDED, FAILED_TO_EXECUTE_ASSERTION, FAILED_TO_RETRIEVE_WLS_SUBJECT, FAULT_BAD_CONTEXT_TOKEN, FAULT_FAILED_AUTHENTICATION, FAULT_FAILED_AUTHORIZATION, FAULT_FAILED_CHECK, FAULT_INVALID_SECURITY, FAULT_INVALID_SECURITY_TOKEN, FAULT_POLICYENFORCEMENT, FAULT_RENEW_NEEDED, FAULT_SECURITY_TOKEN_UNAVAILABLE, FAULT_SOAP_MUST_UNDERSTAND_HEADER, FAULT_UNABLE_TO_RENEW, FAULT_UNKNOWN_DERIVATION_SOURCE, FAULT_UNSUPPORTED_ALGORITHM, FAULT_UNSUPPORTED_CONTEXT_TOKEN, FAULT_UNSUPPORTED_TOKEN, FAULTCODE_GENERIC, HTTP_FAILED_AUTHENTICATION, INTERNAL_ERROR, INVALID_ASSERTION_TYPE, JAXRS_FILTER_ILLEGAL_ARGUMENT, JAXRS_FILTER_UNSUPPORTED_OPERATION, JAXRS_HTTP_SERVLET_REQUEST_OR_RESPONSE_NULL, JAXRS_RESOURCE_CLASS_NULL, LOG_ASSERTION_EXECUTION_FAILED_EXCEPTION, NONSUPPORTED_ASSERTION_TYPE, POLICY_EXECUTION_FAILED, PROBLEM_CLONING_MESSAGE, PROCESS_EVENT_FAILED, PROCESS_FAULT_FAILED, PROCESS_FINISH_FAILED, PROCESS_INIT_FAILED, PROCESS_REQUEST_FAILED, PROCESS_RESPONSE_FAILED, REST_RESOURCE_PATTERN_INVALID_MODULE_NAME, SECURITY_FILTER_INVALID_POLICYSET_METADATA, SECURITY_FILTER_POLICYSET_METADATA_PARSE_ERROR, WSPOLICY_EXECUTION_FAILED_EXCEPTION, WSPOLICY_EXECUTOR_INITIALIZATION_EXCEPTION

Constructor Summary

Constructors

Modifier	Constructor and Description
	WSMException(javax.xml.namespace.QName faultCodeQName) Construct the fault with a predefined fault code QName.
	WSMException(javax.xml.namespace.QName faultCodeQName, java.lang.Throwable cause) Construct the fault with a predefined fault code QName.
	WSMException(java.lang.String faultCodeLocalName) Construct the fault with a predefined fault code.
	WSMException(java.lang.String faultCodeLocalName, java.lang.Object[] args) Construct the fault with a predefined fault code .
protected	WSMException(java.lang.String faultCodeLocalName, java.lang.String message) !!!!WARNING: should not be used directly in oracle package (11g new code) should only be called by extended class Fault.
	WSMException(java.lang.String faultNS, java.lang.String faultCodeLocalName, java.lang.String prefix, java.lang.String faultActor, java.util.List<java.lang.String> detailEntries, java.lang.Throwable cause) Constructor that initialises the fault with a seperate namespace.
	WSMException(java.lang.String faultNS, java.lang.String faultCodeLocalName, java.lang.String prefix, java.lang.String faultActor, java.lang.String detailEntry, java.lang.Throwable cause) Constructor that initialises the fault with a seperate namespace.
protected	WSMException(java.lang.String faultCodeLocalName, java.lang.String message, java.lang.Throwable cause) Backward Compatibility !!!!WARNING: should not be used directly in oracle package (11g new code) should only be called by extended class Fault.
	WSMException(java.lang.String faultCodeLocalName, java.lang.Throwable cause) Construct the fault with a predefined fault code .
	WSMException(java.lang.Throwable cause) For None soap fault, caused by any exception.

Method Summary

Methods

Modifier and Type	Method and Description
void	addDetailEntry(java.lang.String entry)
java.lang.String	getAgentFunction()
java.lang.String	getAssertionName()
java.lang.String	getCategory()
java.util.List<java.lang.String>	getDetailEntries()
java.lang.String	getEcid()
java.lang.String	getFaultActor() Method to get the actor, that experienced the fault.
java.lang.String	getFaultCode() Method to get the Fault Code.
javax.xml.namespace.QName	getFaultCodeAsQName()
java.lang.String	getFaultNS() Method to get the namespace.
java.lang.String	getFaultString()
java.lang.String	getFaultString(java.util.Locale locale) method to return the fault string.
java.lang.String	getLocalizedMessage(java.util.Locale locale) Gets the localized error message that led to the exception corresponding to the given errorCode.
java.lang.String	getMessage() To get the localized error message of this class with default locale
java.lang.String	getPolicyName()
java.lang.String	getPolicyVersion()
boolean	hasServiceFaultCode()
void	setAgentFunction(java.lang.String agentFunction)
void	setAssertionName(java.lang.String assertionName)
void	setCategory(java.lang.String category)
void	setEcid(java.lang.String ecid)
void	setFaultCode(java.lang.String faultCodeLocalName)
void	setPolicyName(java.lang.String policyName)
void	setPolicyVersion(java.lang.String policyVersion)

Methods inherited from class oracle.wsm.common.exception.BaseException

createValidationError, getArguments, getErrorCode, getLocalizedMessage, setBundleType, setErrorCode

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NS_POLICY_ENFORCEMENT

public static final java.lang.String NS_POLICY_ENFORCEMENT

See Also:

Constant Field Values

NS_SECURITY

public static final java.lang.String NS_SECURITY

See Also:

Constant Field Values

NS_PREFIX

public static final java.lang.String NS_PREFIX

See Also:

Constant Field Values

FAULTCODE_QNAME_GENERIC

public static final javax.xml.namespace.QName FAULTCODE_QNAME_GENERIC

FAULTCODE_QNAME_INVALID_SECURITY

public static final javax.xml.namespace.QName FAULTCODE_QNAME_INVALID_SECURITY

FAULTCODE_QNAME_FAILED_CHECK

public static final javax.xml.namespace.QName FAULTCODE_QNAME_FAILED_CHECK

FAULTCODE_QNAME_INVALID_SECURITY_TOKEN

public static final javax.xml.namespace.QName FAULTCODE_QNAME_INVALID_SECURITY_TOKEN

FAULTCODE_QNAME_FAILED_AUTHENTICATION

public static final javax.xml.namespace.QName FAULTCODE_QNAME_FAILED_AUTHENTICATION

FAULTCODE_QNAME_UNSUPPORTED_TOKEN

public static final javax.xml.namespace.QName FAULTCODE_QNAME_UNSUPPORTED_TOKEN

FAULTCODE_QNAME_SECURITY_TOKEN_UNAVAILABLE

public static final javax.xml.namespace.QName FAULTCODE_QNAME_SECURITY_TOKEN_UNAVAILABLE

FAULTCODE_QNAME_SOAP_MUST_UNDERSTAND_HEADER

public static final javax.xml.namespace.QName FAULTCODE_QNAME_SOAP_MUST_UNDERSTAND_HEADER

Constructor Detail

WSMException

protected WSMException(java.lang.String faultCodeLocalName,
            java.lang.String message)

!!!!WARNING: should not be used directly in oracle package (11g new code) should only be called by extended class Fault. Allow explicitly set the message Provided solely for backward compatibility with Fault class

Parameters:

faultCode - - the 10.1.3 errorcode

message - -- 10.1.3 already localized message

WSMException

protected WSMException(java.lang.String faultCodeLocalName,
            java.lang.String message,
            java.lang.Throwable cause)

Backward Compatibility !!!!WARNING: should not be used directly in oracle package (11g new code) should only be called by extended class Fault. Allow explicitly set the message Provided solely for backward compatibility with 10.1.3. Fault class

Parameters:

faultCodeLocalName - - the 10.1.3 errorcode

message - -- 10.1.3 already localized message

cause - -- parent exception/throwable

WSMException

public WSMException(java.lang.Throwable cause)

For None soap fault, caused by any exception. Should be used when caller does not want to provide any predefined fault code and its corresponding locale-specific message of this class but simply tries to inheriate from its parent cause. This is suitable for pure exception class conversion --- to convert from parent cuase to WSMException without specifying new faultCode/message.

Parameters:

cause - The parent cause of this WSMException.

WSMException

public WSMException(java.lang.String faultCodeLocalName)

Construct the fault with a predefined fault code. The fault code should be defined in EnforcementMessageID.java and its corresponding English message should be defined in EnforcementMessageBundle.java

Parameters:

faultCode - The predefined fault code

WSMException

public WSMException(javax.xml.namespace.QName faultCodeQName)

Construct the fault with a predefined fault code QName. The faultCode should be defined in EnforcementMessageID.java and its corresponding English message should be defined in EnforcementMessageBundle.java

Parameters:

faultCodeQName - The predefined fault code QName, often one of the QName constance of this class.

WSMException

public WSMException(java.lang.String faultCodeLocalName,
            java.lang.Throwable cause)

Construct the fault with a predefined fault code . The fault code must be defined in EnforcementMessageID.java and its corresponding English message should be defined in EnforcementMessageBundle.java

Parameters:

faultCodeLocalName - The predefined fault code

cause - The parent cause of this WSMException.

WSMException

public WSMException(javax.xml.namespace.QName faultCodeQName,
            java.lang.Throwable cause)

Construct the fault with a predefined fault code QName. The faultCode must be defined in EnforcementMessageID.java and its corresponding English message should be defined in EnforcementMessageBundle.java

Parameters:

faultCodeQName - The predefined fault code QName, often one of the QName constance of this class.

cause - The parent cause of this WSMException.

WSMException

public WSMException(java.lang.String faultNS,
            java.lang.String faultCodeLocalName,
            java.lang.String prefix,
            java.lang.String faultActor,
            java.util.List<java.lang.String> detailEntries,
            java.lang.Throwable cause)

Constructor that initialises the fault with a seperate namespace. This is used for custom fault schemas.

Parameters:

faultNS - Fault Namespace.

faultCodeLocalName - Must be defined in EnforcementMessageID.java and its corresponding English locale specific message is defined in EnforcementMessageBundle.java

prefix - the prefix of the namespace if there is any

faultActor -

detailEntries - a list of String entries which provide additional information about the fault

cause - The parent cause of the error as an Exception.

WSMException

public WSMException(java.lang.String faultNS,
            java.lang.String faultCodeLocalName,
            java.lang.String prefix,
            java.lang.String faultActor,
            java.lang.String detailEntry,
            java.lang.Throwable cause)

Constructor that initialises the fault with a seperate namespace. This is used for custom fault schemas.

Parameters:

faultNS - Fault Namespace.

faultCodeLocalName - Must be defined in EnforcementMessageID.java and its corresponding English locale specific message is defined in EnforcementMessageBundle.java

prefix - the prefix of the namespace if there is any

faultActor -

detailEntry - adds a detail entry to the list of detailEntries about the fault

cause - The parent cause of the error as an Exception.

WSMException

public WSMException(java.lang.String faultCodeLocalName,
            java.lang.Object[] args)

Construct the fault with a predefined fault code . The fault code must be defined in EnforcementMessageID.java and its corresponding English message should be defined in EnforcementMessageBundle.java

Parameters:

faultCodeLocalName - The predefined fault code

args - Arguments which can be passed.

Method Detail

setFaultCode

public void setFaultCode(java.lang.String faultCodeLocalName)

addDetailEntry

public void addDetailEntry(java.lang.String entry)

getFaultNS

public java.lang.String getFaultNS()

Method to get the namespace.

Returns:

Returns the namespace as set or the default namespace.

getFaultString

public java.lang.String getFaultString(java.util.Locale locale)

method to return the fault string.

Returns:

Fault String as set for the fault.

getLocalizedMessage

public java.lang.String getLocalizedMessage(java.util.Locale locale)

Description copied from class: oracle.wsm.common.exception.BaseException

Gets the localized error message that led to the exception corresponding to the given errorCode.

Overrides:

getLocalizedMessage in class oracle.wsm.common.exception.BaseException

Parameters:

locale - - the locale of which the localized error message is requested.

Returns:

String - the localized error message of its corresponding errorCode. It errorCode is null, message of its parent cause will be returned

getFaultString

public java.lang.String getFaultString()

getMessage

public java.lang.String getMessage()

Description copied from class: oracle.wsm.common.exception.BaseException

To get the localized error message of this class with default locale

Overrides:

getMessage in class oracle.wsm.common.exception.BaseException

getDetailEntries

public java.util.List<java.lang.String> getDetailEntries()

getFaultActor

public java.lang.String getFaultActor()

Method to get the actor, that experienced the fault.

Returns:

The actor that experienced the fault.

hasServiceFaultCode

public boolean hasServiceFaultCode()

getFaultCode

public java.lang.String getFaultCode()

Method to get the Fault Code.

Returns:

Fault code as set for this fault.

getFaultCodeAsQName

public javax.xml.namespace.QName getFaultCodeAsQName()

getEcid

public java.lang.String getEcid()

setEcid

public void setEcid(java.lang.String ecid)

getPolicyName

public java.lang.String getPolicyName()

setPolicyName

public void setPolicyName(java.lang.String policyName)

getPolicyVersion

public java.lang.String getPolicyVersion()

setPolicyVersion

public void setPolicyVersion(java.lang.String policyVersion)

getCategory

public java.lang.String getCategory()

setCategory

public void setCategory(java.lang.String category)

getAssertionName

public java.lang.String getAssertionName()

setAssertionName

public void setAssertionName(java.lang.String assertionName)

getAgentFunction

public java.lang.String getAgentFunction()

setAgentFunction

public void setAgentFunction(java.lang.String agentFunction)