org.jasig.portal
Class ChannelStaticData

java.lang.Object
  java.util.Dictionary<K,V>
      java.util.Hashtable<Object,Object>
          org.jasig.portal.ChannelStaticData

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Deprecated. All IChannel implementations should be migrated to portlets

@Deprecated
public class ChannelStaticData
extends Hashtable<Object,Object>

Used to store channel configuration items and parameters.

Version:

$Revision: 19776 $

Author:

Ken Weiner, Peter Kharchenko, Peter Kharchenko pkharchenko@interactivebusiness.com"

See Also:

Serialized Form

Constructor Summary

ChannelStaticData()
Deprecated.

ChannelStaticData(Map parameters, IUserLayoutManager ulm)
Deprecated. If support is being provided to update channel parameters then a Layout Manager instance is required and the initial values of parameters must be set here to forgo override checks.

Method Summary

boolean	canSetParameter(String key) Deprecated. Returns true if the indicated parameter can be altered.
IAuthorizationPrincipal	getAuthorizationPrincipal() Deprecated. Returns an instance of the IAuthorizationPrincipal for the IPerson
static IAuthorizationPrincipal	getAuthorizationPrincipal(IPerson person) Deprecated. Returns an instance of the IAuthorizationPrincipal for the IPerson
String	getChannelPublishId() Deprecated. Determine channel publish Id.
String	getChannelSubscribeId() Deprecated. Gets the channel subscribe Id
ICCRegistry	getICCRegistry() Deprecated. Obtain inter-channel communication registry object
Context	getJNDIContext() Deprecated. Obtain a channel JNDI context
String	getParameter(String key) Deprecated. Get information contained in a particular element
IPerson	getPerson() Deprecated. Provide information on the user the channel is serving
String	getSerializerName() Deprecated. Sets the serializer name.
long	getTimeout() Deprecated. Maximum time the channel will be allowed to spend in the rendering cycle.
WebApplicationContext	getWebApplicationContext() Deprecated.
void	resetParameter(String key) Deprecated. Resets the value of this parameter.
void	setChannelPublishId(String channelPublishId) Deprecated. Setter method for channel publish Id
void	setChannelSubscribeId(String channelSubscribeId) Deprecated. Sets the channel subscribe Id
void	setICCRegistry(ICCRegistry registry) Deprecated. Set inter-channel communication registry object
void	setJNDIContext(Context c) Deprecated. Set channel JNDI context.
String	setParameter(String key, String value) Deprecated. Set information contained in a channel element Parameters are strings!
void	setParameters(Map params) Deprecated. Copy parameter list from a Map
void	setPerson(IPerson person) Deprecated. Setter method for the user being served by the channel
void	setSerializerName(String serializerName) Deprecated. Setter method for the serializer name.
void	setTimeout(long value) Deprecated. Setter method for channel timeout.
void	setWebApplicationContext(WebApplicationContext webApplicationContext) Deprecated.
void	store() Deprecated. Writes all string valued parameters to the database as part of the user's layout.
String	toString() Deprecated.

Methods inherited from class java.util.Hashtable

clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ChannelStaticData

public ChannelStaticData()

Deprecated.

ChannelStaticData

public ChannelStaticData(Map parameters,
                         IUserLayoutManager ulm)

Deprecated.

If support is being provided to update channel parameters then a Layout Manager instance is required and the initial values of parameters must be set here to forgo override checks. If a LayoutManager is had for ChannelStaticData then setParameter() and setParameters() restrict changing parameters that are not overrideable and hence can not be used to inject the initial parameter values.

Parameters:

parameters -

ulm -

Method Detail

getWebApplicationContext

public WebApplicationContext getWebApplicationContext()

Deprecated.

Returns:

the webApplicationContext

setWebApplicationContext

public void setWebApplicationContext(WebApplicationContext webApplicationContext)

Deprecated.

Parameters:

webApplicationContext - the webApplicationContext to set

getAuthorizationPrincipal

public IAuthorizationPrincipal getAuthorizationPrincipal()

Deprecated.

Returns an instance of the IAuthorizationPrincipal for the IPerson

Returns:

instance of the IAuthorizationPrincipal for the IPerson

getAuthorizationPrincipal

public static IAuthorizationPrincipal getAuthorizationPrincipal(IPerson person)

Deprecated.

Returns an instance of the IAuthorizationPrincipal for the IPerson

Parameters:

person - a IPerson instance

Returns:

instance of the IAuthorizationPrincipal for the IPerson

getChannelPublishId

public String getChannelPublishId()

Deprecated.

Determine channel publish Id.

Returns:

channel's publish Id (defined at publish-time)

getChannelSubscribeId

public String getChannelSubscribeId()

Deprecated.

Gets the channel subscribe Id

Returns:

the channel's Id (defined at subscribe-time)

getJNDIContext

public Context getJNDIContext()

Deprecated.

Obtain a channel JNDI context

Returns:

JNDI context

getParameter

public String getParameter(String key)

Deprecated.

Get information contained in a particular element

Parameters:

key - param name

Returns:

param value

getPerson

public IPerson getPerson()

Deprecated.

Provide information on the user the channel is serving

Returns:

IPerons object.

getTimeout

public long getTimeout()

Deprecated.

Maximum time the channel will be allowed to spend in the rendering cycle.

Returns:

timeout (in milliseconds) after which the channel thread will be killed. Ideally, channels should monitor for this timeout and abort internal execution if the rendering cycle takes too long.

setChannelPublishId

public void setChannelPublishId(String channelPublishId)

Deprecated.

Setter method for channel publish Id

Parameters:

channelPublishId - channel publish Id (defined at a publish-time)

setChannelSubscribeId

public void setChannelSubscribeId(String channelSubscribeId)

Deprecated.

Sets the channel subscribe Id

Parameters:

channelSubscribeId - the channel subscribe Id

setJNDIContext

public void setJNDIContext(Context c)

Deprecated.

Set channel JNDI context.

Parameters:

c - a Context value

setParameter

public String setParameter(String key,
                           String value)

Deprecated.

Set information contained in a channel element Parameters are strings!

Parameters:

key - param name

value - param value

Throws:

IllegalChannelParameterOverrideException - if key is not configured to be overrideable.

canSetParameter

public boolean canSetParameter(String key)
                        throws PortalException

Deprecated.

Returns true if the indicated parameter can be altered. Ad-hoc added parameters will always be allowed to change. Parameters locked during publishing or via the plugged-in layout manager will return false. If no layout manager is available then this method always returns true.

Parameters:

key -

Returns:

boolean

Throws:

PortalException

resetParameter

public void resetParameter(String key)

Deprecated.

Resets the value of this parameter. If this is an overrideable parameter then a user's override will be removed and the original value restored. If this is a non-overrideable parameter this call will have no effect. If this is an ad-hoc parameter then the parameter will be removed. Ad-hoc parameters are ones added by a channel instance beyond the set of parameters specified during channel publishing.

Parameters:

key - param name

store

public void store()
           throws PortalException

Deprecated.

Writes all string valued parameters to the database as part of the user's layout.

Throws:

PortalException

setParameters

public void setParameters(Map params)

Deprecated.

Copy parameter list from a Map

Parameters:

params - a map of params

Throws:

IllegalChannelParameterOverrideException - if key is not configured to be overrideable.

setPerson

public void setPerson(IPerson person)

Deprecated.

Setter method for the user being served by the channel

Parameters:

person - an IPerson value.

setTimeout

public void setTimeout(long value)

Deprecated.

Setter method for channel timeout.

Parameters:

value -

getICCRegistry

public ICCRegistry getICCRegistry()

Deprecated.

Obtain inter-channel communication registry object

Returns:

an ICCRegistry value

setICCRegistry

public void setICCRegistry(ICCRegistry registry)

Deprecated.

Set inter-channel communication registry object

Parameters:

registry - an ICCRegistry value

toString

public String toString()

Deprecated.

Overrides:

toString in class Hashtable<Object,Object>

getSerializerName

public String getSerializerName()

Deprecated.

Sets the serializer name.

Returns:

serializerName

setSerializerName

public void setSerializerName(String serializerName)

Deprecated.

Setter method for the serializer name.

Parameters:

serializerName -