org.apereo.cas.services

Class UnauthorizedServiceException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

org.apereo.cas.services.UnauthorizedServiceException

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UnauthorizedProxyingException, UnauthorizedServiceForPrincipalException, UnauthorizedSsoServiceException

public class UnauthorizedServiceException
extends java.lang.RuntimeException

Exception that is thrown when an Unauthorized Service attempts to use CAS.

Since:

3.0.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CODE_EMPTY_SVC_MGMR Exception object that indicates the service manager is empty with no service definitions.
static java.lang.String	CODE_UNAUTHZ_SERVICE Error code that indicates the service is unauthorized for use.

Constructor Summary

Constructors

Constructor and Description
UnauthorizedServiceException(java.lang.String message) Construct the exception object with the associated error code.
UnauthorizedServiceException(java.lang.String code, java.lang.String message) Constructs an UnauthorizedServiceException with a custom message and the root cause of this exception.
UnauthorizedServiceException(java.lang.String message, java.lang.Throwable cause) Constructs an UnauthorizedServiceException with a custom message and the root cause of this exception.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCode() The error code associated with this exception.

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, 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

CODE_UNAUTHZ_SERVICE

public static final java.lang.String CODE_UNAUTHZ_SERVICE

Error code that indicates the service is unauthorized for use.

See Also:

Constant Field Values

CODE_EMPTY_SVC_MGMR

public static final java.lang.String CODE_EMPTY_SVC_MGMR

Exception object that indicates the service manager is empty with no service definitions.

See Also:

Constant Field Values

Constructor Detail

UnauthorizedServiceException

public UnauthorizedServiceException(java.lang.String message)

Construct the exception object with the associated error code.

Parameters:

message - the error message

UnauthorizedServiceException

public UnauthorizedServiceException(java.lang.String code,
                                    java.lang.String message)

Constructs an UnauthorizedServiceException with a custom message and the root cause of this exception.

Parameters:

message - an explanatory message. Maybe null or blank.

code - the error code mapped to the messaged bundle.

UnauthorizedServiceException

public UnauthorizedServiceException(java.lang.String message,
                                    java.lang.Throwable cause)

Constructs an UnauthorizedServiceException with a custom message and the root cause of this exception.

Parameters:

message - an explanatory message.

cause - the root cause of the exception.

Method Detail

getCode

public java.lang.String getCode()

The error code associated with this exception.

Returns:

the error code.