|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jasig.portal.channels.BaseChannel
org.jasig.portal.channels.CError
CError is the error channel, also known as the null channel, it is designed to render in place of other channels when something goes wrong.
Possible conditions when CError is invoked are:
PortalException
from one of the IChannel or IPrivilegedChannel methods.
Field Summary | |
static int |
AUTHORIZATION_EXCEPTION
|
static int |
CHANNEL_AUTHORIZATION_EXCEPTION
|
static int |
CHANNEL_MISSING_EXCEPTION
|
static int |
GENERAL_ERROR
|
static int |
GENERAL_RENDERING_EXCEPTION
|
static int |
INTERNAL_TIMEOUT_EXCEPTION
|
static int |
RENDER_TIME_EXCEPTION
|
static int |
RESOURCE_MISSING_EXCEPTION
|
static int |
SET_PCS_EXCEPTION
|
static int |
SET_RUNTIME_DATA_EXCEPTION
|
static int |
SET_STATIC_DATA_EXCEPTION
|
static int |
TIMEOUT_EXCEPTION
|
Constructor Summary | |
CError()
|
|
CError(int errorCode,
java.lang.String message,
java.lang.String channelSubscribeId,
IChannel channelInstance)
|
|
CError(int errorCode,
java.lang.Throwable exception,
java.lang.String channelSubscribeId,
IChannel channelInstance)
|
|
CError(int errorCode,
java.lang.Throwable exception,
java.lang.String channelSubscribeId,
IChannel channelInstance,
java.lang.String message)
|
Method Summary | |
ChannelCacheKey |
generateKey()
Requests the channel to generate a key uniqly describing it's current state, and a description of key usage. |
boolean |
isCacheValid(java.lang.Object validity)
Requests the channel to verify validity of the retreived cache based on the validator object. |
void |
renderCharacters(java.io.PrintWriter out)
Asks the channel to render its content as characters. |
void |
renderXML(org.xml.sax.ContentHandler out)
Ask channel to render its content. |
void |
setMessage(java.lang.String m)
|
void |
setPortalControlStructures(PortalControlStructures pcs)
Passes portal control structure to the channel. |
void |
setStaticData(ChannelStaticData sd)
This is so CError can be used by getUserLayout() as a placeholder for channels that have either been deleted from the portal database or the users permission to use the channel has been removed (permanently or temporarily). |
Methods inherited from class org.jasig.portal.channels.BaseChannel |
getRuntimeProperties, receiveEvent, setRuntimeData |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jasig.portal.IChannel |
getRuntimeProperties, receiveEvent, setRuntimeData |
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
Constructor Detail |
public CError()
public CError(int errorCode, java.lang.Throwable exception, java.lang.String channelSubscribeId, IChannel channelInstance)
public CError(int errorCode, java.lang.String message, java.lang.String channelSubscribeId, IChannel channelInstance)
public CError(int errorCode, java.lang.Throwable exception, java.lang.String channelSubscribeId, IChannel channelInstance, java.lang.String message)
Method Detail |
public void setMessage(java.lang.String m)
public void setPortalControlStructures(PortalControlStructures pcs)
IPrivileged
setPortalControlStructures
in interface IPrivileged
PortalControlStructures
public void setStaticData(ChannelStaticData sd)
setStaticData
in interface IChannel
setStaticData
in class BaseChannel
public void renderXML(org.xml.sax.ContentHandler out)
IChannel
renderXML
in interface IChannel
renderXML
in class BaseChannel
public 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 occurs
|
uPortal 2.4.1 API Documentation |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |