com.ibm.portal.state.exceptions
Class CannotInterpretCodecException

java.lang.Object
  java.lang.Throwable
      java.lang.Exception
          com.ibm.portal.state.exceptions.StateException
              com.ibm.portal.state.exceptions.InputMediatorException
                  com.ibm.portal.state.exceptions.UrlInputMediatorException
                      com.ibm.portal.state.exceptions.CannotDecodeStateException
                          com.ibm.portal.state.exceptions.CannotDecodeStateFromStringException
                              com.ibm.portal.state.exceptions.CannotInterpretCodecException

All Implemented Interfaces:

Localized, java.io.Serializable

public abstract class CannotInterpretCodecException
extends CannotDecodeStateFromStringException

Exception representing the error case that the codec information that has been encoded into a URL cannot be interpreted.
The codec indicates how to decode the state portion of the URL. NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:

5.1

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.portal.state.exceptions.CannotDecodeStateFromStringException

CannotDecodeStateFromStringException.Location

Field Summary

Fields inherited from class com.ibm.portal.state.exceptions.CannotDecodeStateFromStringException

location

Fields inherited from class com.ibm.portal.state.exceptions.UrlInputMediatorException

request

Fields inherited from class com.ibm.portal.state.exceptions.InputMediatorException

mediator

Constructor Summary

CannotInterpretCodecException(CannotDecodeStateFromStringException.Location aLocation, java.lang.String aCodec, javax.servlet.http.HttpServletRequest aRequest, com.ibm.portal.state.InputMediator aMediator)
Initializes this exception.

CannotInterpretCodecException(CannotDecodeStateFromStringException.Location aLocation, java.lang.String aCodec, javax.servlet.http.HttpServletRequest aRequest, com.ibm.portal.state.InputMediator aMediator, java.lang.Exception reason)
Initializes this exception.

Method Summary

java.lang.String

getCodec() Returns the codec that cannot be interpreted.

Methods inherited from class com.ibm.portal.state.exceptions.CannotDecodeStateFromStringException

getLocation

Methods inherited from class com.ibm.portal.state.exceptions.InputMediatorException

getMediator

Methods inherited from class java.lang.Throwable

fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

Constructor Detail

CannotInterpretCodecException

public CannotInterpretCodecException(CannotDecodeStateFromStringException.Location aLocation,
                                     java.lang.String aCodec,
                                     javax.servlet.http.HttpServletRequest aRequest,
                                     com.ibm.portal.state.InputMediator aMediator)

Initializes this exception.

Parameters:

aLocation - location of the fault

aCodec - The String identifier representing the codec that cannot be interpreted.

aRequest - The current servlet request.

aMediator - The input mediator that received the request URL in order to retrieve (and decode) the state holder (from it).

CannotInterpretCodecException

public CannotInterpretCodecException(CannotDecodeStateFromStringException.Location aLocation,
                                     java.lang.String aCodec,
                                     javax.servlet.http.HttpServletRequest aRequest,
                                     com.ibm.portal.state.InputMediator aMediator,
                                     java.lang.Exception reason)

Initializes this exception.

Parameters:

aLocation - location of the fault

aCodec - The String identifier representing the codec that cannot be interpreted.

aRequest - The current servlet request.

aMediator - The input mediator that received the request URL in order to retrieve (and decode) the state holder from it.

reason - The reason for this exception.

Method Detail

getCodec

public java.lang.String getCodec()

Returns the codec that cannot be interpreted.

Returns:

String representing the unknown codec.