org.jasig.portal.channels.jsp
Class ServantChannel

java.lang.Object
  org.jasig.portal.channels.BaseChannel
      org.jasig.portal.channels.jsp.Channel
          org.jasig.portal.channels.jsp.ServantChannel

All Implemented Interfaces:

IServantController, ICacheable, IChannel, ICharacterChannel, IDirectResponse, IPrivileged, IPrivilegedChannel

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class ServantChannel
extends Channel
implements IServantController

Author:

Mark Boyd TODO To change the template for this generated type comment go to Window - Preferences - Java - Code Style - Code Templates

Field Summary

Fields inherited from class org.jasig.portal.channels.jsp.Channel

CAR_DEPLOYMENT, mController, mControllerClassname, TRADITIONAL_DEPLOYMENT

Fields inherited from class org.jasig.portal.channels.BaseChannel

log, runtimeData, staticData

Fields inherited from interface org.jasig.portal.ICacheable

CHANNEL_CACHE_KEY_INSTANCE_SCOPE, CHANNEL_CACHE_KEY_SCOPE_PARAM_NAME, CHANNEL_CACHE_KEY_SYSTEM_SCOPE

Constructor Summary

ServantChannel(String controllerClassName)
Deprecated. Custom constructor used to create a an instance of this class that implements the IServant interface.

Method Summary

void	configure(Object o) Deprecated. Delegates to the controller if it supports IJspChannelServant.
Object[]	getResults() Deprecated. Delegates to the controller if it supports IJspChannelServant.
boolean	isFinished() Deprecated. Delegates to the controller if it supports IJspChannelServant.

Methods inherited from class org.jasig.portal.channels.jsp.Channel

generateKey, isCacheValid, receiveEvent, renderCharacters, setPortalControlStructures, setResponse, setRuntimeData, setStaticData

Methods inherited from class org.jasig.portal.channels.BaseChannel

getRuntimeProperties, renderXML, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.portal.IChannel

getRuntimeProperties, renderXML

Constructor Detail

ServantChannel

public ServantChannel(String controllerClassName)
               throws PortalException

Deprecated.

Custom constructor used to create a an instance of this class that implements the IServant interface. Since servants use the containing channel's ChannelStaticData we don't want to have to corrupt that object by setting the "controllerClass" parameter. Hence this constructor takes the class name of the controller as a parameter. If this value is null it will result in the lookup in the ChannelStaticData object. Furthermore, since this is a servant its instance is unknown to ChannelManager. Therefore it will never have its PortalControlStructures called which is manditory for the jsp channel type. Hence for using any jsp channel type servant a containing channel must itself be an IPriviledgedChannel implementation and must pass the PortalControlStructures to this channel prior to calling setRuntimeData and update them whenever its own setPortalControlStructures() method is called. WARNING: The jsp channel handles controllers from within CARs in a special manner to extract classes, properties, and JSPs from the CAR and make them available to the web server's classloader and JSP compiler. This handling mechanism depends on the controller class not as yet being loaded by the classloader before the jsp channel attempts to load the class. Therefore, the String passed into this constructor should not be obtained from theControllerClass.getName() unless that class does not reside in a CAR. Such a call causes that class to be loaded and will prevent the proper deployment of CAR resources for that class.

Throws:

PortalException

Method Detail

isFinished

public boolean isFinished()

Deprecated.

Delegates to the controller if it supports IJspChannelServant. Throws an UnsupportedOperationException if it doesn't.

Specified by:

isFinished in interface IServantController

Returns:

boolean

See Also:

IServantController.isFinished()

getResults

public Object[] getResults()

Deprecated.

Delegates to the controller if it supports IJspChannelServant. Throws an UnsupportedOperationException if it doesn't.

Specified by:

getResults in interface IServantController

Returns:

Object[] the expected Object type should be documented by the IController implementation

See Also:

IServantController.getResults()

configure

public void configure(Object o)

Deprecated.

Delegates to the controller if it supports IJspChannelServant. Throws an UnsupportedOperationException if it doesn't.

Specified by:

configure in interface IServantController

See Also:

IServantController.configure(java.lang.Object)