| java.lang.Object
 com.sun.portal.taskadmin.ChannelTaskAdmin
All known Subclasses: com.sun.portal.taskadmin.WSRPTaskAdmin, com.sun.portal.taskadmin.PortletTaskAdmin, com.sun.portal.desktop.admin.mbeans.tasks.DPTreeHelper,
| ChannelTaskAdmin | | public class ChannelTaskAdmin implements TaskAdminConstants(Code) | | This class implements the APIs that can be used
to achieve a set of administrative tasks associated
with channels/containers.
|
| Constructor Summary | |
| public | ChannelTaskAdmin(HttpServletRequest req, String baseDN)
| | public | ChannelTaskAdmin(SSOToken ssoToken, String baseDN, String portalId)
| | public | ChannelTaskAdmin(SSOToken ssoToken, String baseDN, String portalId, boolean resetData)
| | public | ChannelTaskAdmin(SSOToken ssoToken, String baseDN, String portalId, boolean merge, boolean resetData)
This constructor can be called from inside an MBean and it constructs
dpRoot without mergers. | | public | ChannelTaskAdmin(HttpServletRequest req, DPRoot someDPRoot)
| | public | ChannelTaskAdmin(SSOToken token, DPRoot someDPRoot)
|
| Method Summary | |
| protected boolean | canAccess(String channel)
| | public void | createChannel(String channelName, String providerName)
Creates a new channel.
A new channel is created based on the named provider.
To create a nested channel, supply a hierarchical channel
name. | | public void | createContainer(String channelName, String providerName)
Creates a new container.
A new container is created based on the named provider.
To create a nested container, supply a hierarchical container
name. | | public void | createNodeProperty(String fqcn, String rpn, String client, String locale, String name, Object value, Boolean advanced)
| | public void | deleteChannel(String channelName, String parentcontainer)
Deletes a channel/container. | | protected boolean | existsChannel(String channel)
| | protected boolean | existsProvider(String provider)
| | public Set | getAssignableChannels(String container)
This method returns the list of channels/containers that are assignable
to the available and selected list of a container.
This method returns the list of channels which includes
the container's children and the container's parent's
children, parent's parent's children and traverses recursively
until it reaches the Display Profile root.
Mergers are taken into account when the channels are traversed.
Parameters:
container - container name for which channels has to be assigned. | | public List | getAvailableChannels(String containerName)
Gets the available channels for the container channel at a
particular baseDN. | | public Set | getBaseDNs()
This method returns the list of baseDNs that
the user in session can administer. | | public boolean | getBooleanProperty(String channelName, String key, List pflist)
Return the value for channel's boolean property. | | protected Set | getChannelNames(DPNode node)
| | public String | getClassName(String channelname)
This method returns the classname of the provider
that this channel is based on. | | protected DPChannel | getDPChannel(String channelName)
| | public String | getDPPriority()
| | protected DPRoot | getDPRootByDN(String baseDN)
| | protected DPRoot | getDPRootByDN(String baseDN, boolean merge, boolean resetData)
| | public Set | getExistingChannels(boolean all)
This method returns the list of channels that are existing
at the baseDN. | | public Set | getExistingChannels(boolean all, String regExp)
This method returns the list of channels that match the
search string. | | public Set | getExistingContainerProviders()
This method returns the list of containerproviders that are existing
at the baseDN that is passed in. | | public Set | getExistingContainers(boolean all)
This method returns the list of containers that are existing
at the baseDN that is passed in. | | public Set | getExistingContainers(boolean all, String regExp)
This method returns the list of containers that match the
search string. | | public Set | getExistingProviders()
This method returns the list of providers that are existing
at the baseDN that is passed in. | | protected String | getFollowing(String source, String substring, String nameSeparator)
If source is c1/c2/c3/c4 and substring is c2, then this method
returns c3/c4. | | public Set | getGlobalPropertyNames()
This method returns the list of global property names that are existing
at the baseDN that is passed in. | | protected String | getHead(String rpn, String nameSeparator)
Relative Path Name (RPN) is similar to
FQCN(fully qualified channel name) and is in the form
"c1/c2/c3/c4". | | public int | getIntegerProperty(String channelName, String key, List pflist)
Return the value for channel integer property. | | public List | getListProperty(String channelName, String key, List pflist)
This method returns the List collection object for the given
collection property. | | public Map | getMapProperty(String channelName, String key, List pflist)
This method returns the Map collection object for the given
collection property. | | public List | getMergedDNs()
| | public Map | getNodeProperties(String fqcn, String rpn, String client, String locale)
| | protected String | getPreceding(String source, String substring, String nameSeparator)
If source is c1/c2/c3/c4 and substring is c4, then this method
returns c1/c2/c3. | | public Set | getPropertyNames(String channelName, boolean advanced)
This method returns the list of property names that are existing
at the baseDN and at the given channel name that is passed in. | | public Set | getPropertyNames(String channelName, String regExp, boolean advanced)
Return the Set contaning property names that matches the given regular expression. | | public Set | getPropertyNames(String channelName, List pflist, boolean advanced)
This method returns the list of property names that are existing
at the baseDN and at the given channel name that is passed in. | | public short | getPropertyType(String channelName, String propertyName)
This method returns the property type for the given property name.
Parameters:
channelName - channel name. | | protected Set | getProviderNames(DPNode node)
| | public ResourceBundle | getResourceBundle()
| | public String | getRoleName(String roleDN)
| | public List | getSelectedChannels(String containerName)
Gets the selected channels for the container channel at a
particular baseDN. | | public String | getStringProperty(String channelName, String key, List pflist)
Return the value for channel String property. | | public void | init(SSOToken ssoToken, String baseDN, String portalId, boolean merge, boolean resetData)
| | public boolean | isContainer(String channelName)
| | protected boolean | isDisplayable(String fqcn)
| | public boolean | isTabContainer(String channelName)
| | public void | removeCustomization(String fqcn, String rpn, String client, String locale, List names)
| | public void | setAvailableChannels(List available, String containerName)
Sets the available channels for the container channel at a
particular baseDN. | | public void | setBooleanProperty(String channelName, String key, boolean value, List pflist)
| | public void | setDPPriority(String priority)
| | public void | setIntegerProperty(String channelName, String key, int value, List pflist)
| | public void | setListProperty(String channelName, String key, List value, List pflist)
| | public void | setMapProperty(String channelName, String key, Map value, List pflist)
| | public void | setNodeProperties(String fqcn, String rpn, String client, String locale, Object values)
| | public void | setSelectedChannels(List selected, String containerName)
Sets the selected channels for the container channel at a
particular baseDN. | | public void | setStringProperty(String channelName, String key, String value, List pflist)
| | public void | store()
|
| BOOLEAN_DP | | public static short BOOLEAN_DP(Code) | | |
| CHANNEL_NAME_SEPARATOR | | public static String CHANNEL_NAME_SEPARATOR(Code) | | Channel Name Seaparator used for nested channel names.
|
| COLLECTION_DP | | public static short COLLECTION_DP(Code) | | |
| COLLECTION_NAME_SEPARATOR | | public static String COLLECTION_NAME_SEPARATOR(Code) | | |
| CONDITIONAL_DP | | public static short CONDITIONAL_DP(Code) | | |
| CONDITIONAL_PREFIX | | String CONDITIONAL_PREFIX(Code) | | Name of a conditional property is derived by DPAPI from its condition
and value and is prefixed by this string.
|
| INTEGER_DP | | public static short INTEGER_DP(Code) | | |
| LOCALE_DP | | public static short LOCALE_DP(Code) | | |
| REMOTE_PORTLET_CLASS | | protected static String REMOTE_PORTLET_CLASS(Code) | | |
| STRING_DP | | public static short STRING_DP(Code) | | |
| UNKNOWN_DP | | public static short UNKNOWN_DP(Code) | | |
| dpDocExists | | protected boolean dpDocExists(Code) | | |
| dpRootMerged | | protected boolean dpRootMerged(Code) | | |
| ChannelTaskAdmin | | public ChannelTaskAdmin(SSOToken ssoToken, String baseDN, String portalId, boolean merge, boolean resetData) throws TaskAdminException(Code) | | This constructor can be called from inside an MBean and it constructs
dpRoot without mergers. It is useful for removeCustomization kind of
operations
|
| canAccess | | protected boolean canAccess(String channel)(Code) | | Checks if the current user can access a given channel
Parameters:
channel - Fully qualified name of the channel as a String true if the use can access. |
| createChannel | | public void createChannel(String channelName, String providerName) throws TaskAdminException(Code) | | Creates a new channel.
A new channel is created based on the named provider.
To create a nested channel, supply a hierarchical channel
name. For example, to create channel A inside of container X, based on
provider P:
createChannel("X" + "/" + "A", "P");
|
| createContainer | | public void createContainer(String channelName, String providerName) throws TaskAdminException(Code) | | Creates a new container.
A new container is created based on the named provider.
To create a nested container, supply a hierarchical container
name. For example, to create container A inside of container X, based on
provider P :
createContainer("X" + "/" + "A", "P");
|
| deleteChannel | | public void deleteChannel(String channelName, String parentcontainer) throws TaskAdminException(Code) | | Deletes a channel/container.
To delete a nested channel/container, supply parent name.
For example, to delete channel A inside
of container X:
deleteChannel("A", "X");
|
| existsChannel | | protected boolean existsChannel(String channel)(Code) | | |
| existsProvider | | protected boolean existsProvider(String provider)(Code) | | |
| getAssignableChannels | | public Set getAssignableChannels(String container) throws TaskAdminException(Code) | | This method returns the list of channels/containers that are assignable
to the available and selected list of a container.
This method returns the list of channels which includes
the container's children and the container's parent's
children, parent's parent's children and traverses recursively
until it reaches the Display Profile root.
Mergers are taken into account when the channels are traversed.
Parameters:
container - container name for which channels has to be assigned. Set of channels that can be assignable. |
| getAvailableChannels | | public List getAvailableChannels(String containerName) throws TaskAdminException(Code) | | Gets the available channels for the container channel at a
particular baseDN.
|
| getBaseDNs | | public Set getBaseDNs()(Code) | | This method returns the list of baseDNs that
the user in session can administer.
|
| getBooleanProperty | | public boolean getBooleanProperty(String channelName, String key, List pflist) throws TaskAdminException(Code) | | Return the value for channel's boolean property.
Parameters:
channelName - channel name.
Parameters:
key - property name
Parameters:
pflist - properties filter list value of the boolean property.
throws:
TaskAdminException - |
| getClassName | | public String getClassName(String channelname) throws TaskAdminException(Code) | | This method returns the classname of the provider
that this channel is based on. It returns null if the provider
for the given channel name doesn't exists.
|
| getExistingChannels | | public Set getExistingChannels(boolean all) throws TaskAdminException(Code) | | This method returns the list of channels that are existing
at the baseDN. The channels in this list
can be modifiable or deleted by the user that can administer
the baseDN.
This method returns the list of channels which includes
the channels defined at the baseDN that is passed in, channels
defined inside the containers that are defined at the baseDN.
if specified all, all the channels from the merged list is returned.
Parameters:
all - all the channels from mergers Set of channels that are available at this baseDN. |
| getExistingChannels | | public Set getExistingChannels(boolean all, String regExp) throws TaskAdminException(Code) | | This method returns the list of channels that match the
search string. The search is done on the list of channels
that is returned from the getExistingChannels.
at the baseDN that is passed in. The channels in this list
can be modifiable or deleted by the user that can administer
the baseDN that is passed in.
This method returns the list of channels which includes
the channels defined at the baseDN that is passed in, channels
defined inside the containers that are defined at the baseDN.
Parameters:
all - flag that specifies take mergers into account. Set of channels that are available at this baseDN. |
| getExistingContainerProviders | | public Set getExistingContainerProviders() throws TaskAdminException(Code) | | This method returns the list of containerproviders that are existing
at the baseDN that is passed in. The containerproviders in this list
can be used to create container channels by the user that can administer
the baseDN that is passed in. Always takes mergers into account.
Set of containerproviders that are available at this baseDN. |
| getExistingContainers | | public Set getExistingContainers(boolean all) throws TaskAdminException(Code) | | This method returns the list of containers that are existing
at the baseDN that is passed in. The containers in this list
can be modifiable or deleted by the user that can administer
the baseDN that is passed in.
This method returns the list of containers which includes
the containers defined at the baseDN that is passed in, containers
defined inside the containers that are defined at the baseDN.
if specified all, all the containers from the merged list is returned.
Parameters:
all - all the channels from mergers Set of channels that are available at this baseDN. |
| getExistingContainers | | public Set getExistingContainers(boolean all, String regExp) throws TaskAdminException(Code) | | This method returns the list of containers that match the
search string. The search is done on the list of containers
that is returned from the getExistingContainers.
at the baseDN that is passed in. The containerls in this list
can be modifiable or deleted by the user that can administer
the baseDN that is passed in.
This method returns the list of containers which includes
the containers defined at the baseDN that is passed in, containers
defined inside the containers that are defined at the baseDN.
Parameters:
all - flag that specifies take mergers into account. Set of channels that are available at this baseDN. |
| getExistingProviders | | public Set getExistingProviders() throws TaskAdminException(Code) | | This method returns the list of providers that are existing
at the baseDN that is passed in. The providers in this list
can be used to create channels by the user that can administer
the baseDN that is passed in. Always takes mergers into account.
Set of providers that are available at this baseDN. |
| getFollowing | | protected String getFollowing(String source, String substring, String nameSeparator)(Code) | | If source is c1/c2/c3/c4 and substring is c2, then this method
returns c3/c4. It returns null if there is no string following
the substring or if substring is not found in the source.
|
| getGlobalPropertyNames | | public Set getGlobalPropertyNames() throws TaskAdminException(Code) | | This method returns the list of global property names that are existing
at the baseDN that is passed in. *
Set Contaning property name list. |
| getHead | | protected String getHead(String rpn, String nameSeparator)(Code) | | Relative Path Name (RPN) is similar to
FQCN(fully qualified channel name) and is in the form
"c1/c2/c3/c4". This method returns c1.
Parameters:
rpn - Relative path name |
| getIntegerProperty | | public int getIntegerProperty(String channelName, String key, List pflist) throws TaskAdminException(Code) | | Return the value for channel integer property.
Parameters:
channelName - channel name.
Parameters:
key - property name
Parameters:
pflist - properties filter list value of the integer property.
throws:
TaskAdminException - |
| getListProperty | | public List getListProperty(String channelName, String key, List pflist) throws TaskAdminException(Code) | | This method returns the List collection object for the given
collection property.
Parameters:
channelName - channel name.
Parameters:
key - property name
Parameters:
pflist -
throws:
TaskAdminException - |
| getMapProperty | | public Map getMapProperty(String channelName, String key, List pflist) throws TaskAdminException(Code) | | This method returns the Map collection object for the given
collection property.
Parameters:
channelName - channel name.
Parameters:
key - property name
Parameters:
pflist -
throws:
TaskAdminException - |
| getPreceding | | protected String getPreceding(String source, String substring, String nameSeparator)(Code) | | If source is c1/c2/c3/c4 and substring is c4, then this method
returns c1/c2/c3. It returns null if there is no string preceding
the substring or if substring is not found in the source.
|
| getPropertyNames | | public Set getPropertyNames(String channelName, boolean advanced) throws TaskAdminException(Code) | | This method returns the list of property names that are existing
at the baseDN and at the given channel name that is passed in. This method
returns only the default property names and filters out all the conditional
properties.
Parameters:
channelName - the channel name for which property names list to be returned.
Parameters:
advanced - advanced flag to specify whether to return basic/advanced propertynames. Set Contaning property name list. |
| getPropertyNames | | public Set getPropertyNames(String channelName, String regExp, boolean advanced) throws TaskAdminException(Code) | | Return the Set contaning property names that matches the given regular expression.
Parameters:
channelName - channel name.
Parameters:
regExp - string which needs to be searched.
Parameters:
advanced - advanced flag to specify whether to return basic/advanced propertynames.
throws:
TaskAdminException - |
| getPropertyNames | | public Set getPropertyNames(String channelName, List pflist, boolean advanced) throws TaskAdminException(Code) | | This method returns the list of property names that are existing
at the baseDN and at the given channel name that is passed in. This method
returns only the conditional property names and filters out all the default
properties which are not defined as conditional properties.
This method assumes that any property that is defined as conditional will
have an entry for the default.
Parameters:
channelName - the channel name for which property names list to be returned.
Parameters:
advanced - advanced flag to specify whether to return basic/advanced propertynames. Set Contaning property name list. |
| getPropertyType | | public short getPropertyType(String channelName, String propertyName) throws TaskAdminException(Code) | | This method returns the property type for the given property name.
Parameters:
channelName - channel name. short value indicating property type.
throws:
TaskAdminException - |
| getSelectedChannels | | public List getSelectedChannels(String containerName) throws TaskAdminException(Code) | | Gets the selected channels for the container channel at a
particular baseDN.
|
| getStringProperty | | public String getStringProperty(String channelName, String key, List pflist) throws TaskAdminException(Code) | | Return the value for channel String property.
Parameters:
channelName - channel name.
Parameters:
key - property name
Parameters:
pflist - properties filter list Value of the string property.
throws:
TaskAdminException - |
| isDisplayable | | protected boolean isDisplayable(String fqcn)(Code) | | Checks if the channel/container should be displayed to the user
|
| setAvailableChannels | | public void setAvailableChannels(List available, String containerName) throws TaskAdminException(Code) | | Sets the available channels for the container channel at a
particular baseDN.
|
| setSelectedChannels | | public void setSelectedChannels(List selected, String containerName) throws TaskAdminException(Code) | | Sets the selected channels for the container channel at a
particular baseDN.
|
|
|