|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.CError
public class CError
Deprecated legacy stub channel. CError has been moved to the org.jasig.portal.error package. This class exists to provide backwards compatibility -- it delegates to the org.jasig.portal.error.CError channel.
Field Summary | |
---|---|
static int |
AUTHORIZATION_EXCEPTION
Deprecated. |
static int |
CHANNEL_AUTHORIZATION_EXCEPTION
Deprecated. Error code representing failure to render due to lack of authorization. |
static int |
CHANNEL_MISSING_EXCEPTION
Deprecated. Error code representing the channel being just plain missing. |
private CError |
delegate
Deprecated. The modern CError instance to which we delegate. |
static int |
GENERAL_ERROR
Deprecated. Generic error code |
static int |
GENERAL_RENDERING_EXCEPTION
Deprecated. |
static int |
INTERNAL_TIMEOUT_EXCEPTION
Deprecated. |
static int |
RENDER_TIME_EXCEPTION
Deprecated. Error code for failure during rendering. |
static int |
RESOURCE_MISSING_EXCEPTION
Deprecated. |
static int |
SET_PCS_EXCEPTION
Deprecated. Error code representing failure when framework attempts to set channel portal control structures. |
static int |
SET_RUNTIME_DATA_EXCEPTION
Deprecated. Error code for errors at time runtime data is set. |
static int |
SET_STATIC_DATA_EXCEPTION
Deprecated. Error code for errors at time static data is set |
static int |
TIMEOUT_EXCEPTION
Deprecated. Error code for channels that fail to complete rendering during allotted time. |
Constructor Summary | |
---|---|
CError()
Deprecated. Construct an uninitialized instance of the CError channel. |
|
CError(int errorCode,
java.lang.String message,
java.lang.String channelSubscribeId,
IChannel channelInstance)
Deprecated. Instantiate a CError representing a particular channel's failure, including a message and errorCode, but not a Throwable. |
|
CError(int errorCode,
java.lang.Throwable throwable,
java.lang.String channelSubscribeId,
IChannel channelInstance)
Deprecated. Construct an instance of the Error channel representing a failure to render of a particular subscribed channel for reason of having thrown a Throwable. |
|
CError(int errorCode,
java.lang.Throwable exception,
java.lang.String channelSubscribeId,
IChannel channelInstance,
java.lang.String message)
Deprecated. Instantiate a CError instance representing the failure of some particular channel, including an error code, message, and the Throwable. |
Method Summary | |
---|---|
ChannelCacheKey |
generateKey()
Deprecated. Requests the channel to generate a key uniqly describing it's current state, and a description of key usage. |
ChannelRuntimeProperties |
getRuntimeProperties()
Deprecated. Acquires ChannelRuntimeProperties from the channel. |
boolean |
isCacheValid(java.lang.Object validity)
Deprecated. Requests the channel to verify validity of the retreived cache based on the validator object. |
void |
receiveEvent(PortalEvent ev)
Deprecated. Passes an outside event to a channel. |
void |
renderCharacters(java.io.PrintWriter out)
Deprecated. Asks the channel to render its content as characters. |
void |
renderXML(org.xml.sax.ContentHandler out)
Deprecated. Ask channel to render its content. |
void |
setMessage(java.lang.String m)
Deprecated. Set the failure message. |
void |
setPortalControlStructures(PortalControlStructures pcs)
Deprecated. Passes portal control structure to the channel. |
void |
setRuntimeData(ChannelRuntimeData rd)
Deprecated. Passes ChannelRuntimeData to the channel. |
void |
setStaticData(ChannelStaticData sd)
Deprecated. Passes ChannelStaticData to the channel. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int GENERAL_ERROR
public static final int RENDER_TIME_EXCEPTION
public static final int SET_STATIC_DATA_EXCEPTION
public static final int SET_RUNTIME_DATA_EXCEPTION
public static final int TIMEOUT_EXCEPTION
public static final int SET_PCS_EXCEPTION
public static final int CHANNEL_AUTHORIZATION_EXCEPTION
public static final int CHANNEL_MISSING_EXCEPTION
public static final int GENERAL_RENDERING_EXCEPTION
public static final int INTERNAL_TIMEOUT_EXCEPTION
public static final int AUTHORIZATION_EXCEPTION
public static final int RESOURCE_MISSING_EXCEPTION
private CError delegate
Constructor Detail |
---|
public CError()
public CError(int errorCode, java.lang.Throwable throwable, java.lang.String channelSubscribeId, IChannel channelInstance)
errorCode
- - one of the static error codes of this classthrowable
- - cause of failed channel's failurechannelSubscribeId
- - identifies the failed channelchannelInstance
- - the failed channelpublic CError(int errorCode, java.lang.String message, java.lang.String channelSubscribeId, IChannel channelInstance)
errorCode
- - one of the static error codes of this classmessage
- - describes errorchannelSubscribeId
- - identifies failed channelchannelInstance
- - failed channelpublic CError(int errorCode, java.lang.Throwable exception, java.lang.String channelSubscribeId, IChannel channelInstance, java.lang.String message)
errorCode
- - one of the static error codes of this classexception
- - thrown by the failed channelchannelSubscribeId
- - identifies failed channelchannelInstance
- - the failed channel instancemessage
- - message describing failureMethod Detail |
---|
public void setMessage(java.lang.String m)
m
- - a mesage describing the error.public void setPortalControlStructures(PortalControlStructures pcs)
IPrivileged
setPortalControlStructures
in interface IPrivileged
PortalControlStructures
public void setStaticData(ChannelStaticData sd)
IChannel
setStaticData
in interface IChannel
sd
- channel static dataChannelStaticData
public void renderXML(org.xml.sax.ContentHandler out)
IChannel
renderXML
in interface IChannel
out
- the SAX ContentHandler to output content topublic ChannelCacheKey generateKey()
ICacheable
generateKey
in interface ICacheable
public boolean isCacheValid(java.lang.Object validity)
ICacheable
isCacheValid
in interface ICacheable
public void renderCharacters(java.io.PrintWriter out) throws PortalException
ICharacterChannel
renderCharacters
in interface ICharacterChannel
out
- a PrintWriter
value into which the character output should be directed
PortalException
- if an error occurspublic void setRuntimeData(ChannelRuntimeData rd) throws PortalException
IChannel
setRuntimeData
in interface IChannel
rd
- channel runtime data
PortalException
ChannelRuntimeData
public void receiveEvent(PortalEvent ev)
IChannel
receiveEvent
in interface IChannel
ev
- PortalEvent objectPortalEvent
public ChannelRuntimeProperties getRuntimeProperties()
IChannel
getRuntimeProperties
in interface IChannel
ChannelRuntimeProperties
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |