TransportChannelService MBean

Partial ObjectName:
WebSphere:*,type=TransportChannelService


MBean TransportChannelService

Runtime control of the Transport Channel Service

Since:

6.0


Operation Summary

com.ibm.websphere.channel.framework.ChannelFactoryDataupdateAllChannelFactoryProperties(java.lang.Class type, java.util.Map properties)
           Registers common properties that are to be shared by all instances of a channel generated by a given channel factory.
com.ibm.websphere.channel.framework.ChannelFactoryDataupdateChannelFactoryProperty(java.lang.Class type, java.lang.Object key, java.lang.Object value)
           Updates a single ChannelFactory property.
com.ibm.websphere.channel.framework.ChannelFactoryDatagetChannelFactory(java.lang.Class type)
           Fetch an existing channel factory from the transport channel service.
com.ibm.websphere.channel.framework.ChannelDataaddChannel(java.lang.String name, java.lang.Class factoryType, java.util.Map properties, int weight)
           creates a named channel data object and instantiates an instance of its channel factory (if one does not already exist).
com.ibm.websphere.channel.framework.ChannelDataaddChannel(java.lang.String name, java.lang.Class factoryType, java.util.Map properties)
           Creates a named channel data objet and instantiates an instance of its channel factory (if one does not already exist).
com.ibm.websphere.channel.framework.ChannelDataremoveChannel(java.lang.String name)
           Remove a channel; if the channel is in use by the transport channel service, an exception will be thrown.
com.ibm.websphere.channel.framework.ChannelDataupdateChannelWeight(java.lang.String name, int weight)
           Update the new discrimination weight to be used when this channel is running.
com.ibm.websphere.channel.framework.ChannelDataupdateChannelProperty(java.lang.String name, java.lang.Object key, java.lang.Object value)
           Update a single property that is use by the input named channel.
com.ibm.websphere.channel.framework.ChannelDataupdateAllChannelProperties(java.lang.String name, java.util.Map properties)
           Update the entire set of properties in use by the input named channel.
com.ibm.websphere.channel.framework.ChannelDatagetChannel(java.lang.String name)
           Returns a channel data object for a specific named channel.
com.ibm.websphere.channel.framework.ChannelData[]getAllChannels()
           Return the entire of set of channels that have been added via this interface's addChannel methods.
com.ibm.websphere.channel.framework.ChannelData[]getRunningChannels()
           Return the entire of set of channels that have been added via this interface's addChannel methods and are in use by the runtime.
com.ibm.websphere.channel.framework.ChainDataaddChain(java.lang.String name, com.ibm.websphere.channel.framework.FlowType type, java.lang.String[] channels)
           Create a specific named chain and the structures to prepare this chain to be created.
com.ibm.websphere.channel.framework.ChainDataaddChain(java.lang.String name, com.ibm.websphere.channel.framework.FlowType type, java.lang.String[] channels, java.lang.String acceptorID)
           Create a specific named chain and the structures to prepare this chain to be created.
com.ibm.websphere.channel.framework.ChainDataremoveChain(java.lang.String name)
           Remove a chain.
com.ibm.websphere.channel.framework.ChainDataupdateChain(java.lang.String name, java.lang.String[] channels)
           Updates a chain with a new set of channels.
com.ibm.websphere.channel.framework.ChainDatagetChain(java.lang.String name)
          
com.ibm.websphere.channel.framework.ChainData[]getAllChains()
          
com.ibm.websphere.channel.framework.ChainData[]getAllChains(java.lang.String channelName)
           Fetch all chains in the transport channel service which include the given channel.
com.ibm.websphere.channel.framework.ChainData[]getAllChains(java.lang.Class factoryClass)
           Fetch all chains in the transport channel service that include channels created from the given factory class.
com.ibm.websphere.channel.framework.ChainData[]getRunningChains()
           Fetch all chains in the transport channel service that have been initialized and are currently running.
com.ibm.websphere.channel.framework.ChainData[]getRunningChains(java.lang.String channelName)
           Fetch all chains in the transport channel service that have been initialized and are currently running which include the given channel.
com.ibm.websphere.channel.framework.ChainData[]getRunningChains(java.lang.Class factoryClass)
           Fetch all chains in the transport channel service that have been initialized and are currently running which include a channel created by the given factory.
voidstartChain(java.lang.String name)
          
voidstopChain(java.lang.String name, long delay)
          
voidstartChainsByAcceptorID(java.lang.String acceptorID)
           This method will start all enabled inbound chains associated with a given acceptor object.
voidstopChainsByAcceptorID(java.lang.String acceptorID, long delay)
           This method will stop all running inbound chains associated with a given acceptor object.
com.ibm.wsspi.channel.framework.CFEndPointgetEndPoint(java.lang.String name)
           Fetch the CFEndPoint representation of the given inbound chain.
com.ibm.wsspi.channel.framework.CFEndPoint[]getEndPointsByAcceptorID(java.lang.String acceptorID)
           Fetch all CFEndPoint representations for the chains that match the given acceptor identifier.

Operation Detail

updateAllChannelFactoryProperties

public com.ibm.websphere.channel.framework.ChannelFactoryData updateAllChannelFactoryProperties(java.lang.Class type, java.util.Map properties)

     Registers common properties that are to be shared by all instances of a channel generated by a given channel factory.

Parameters:

     type - channel factory class for which properties are to be associated
     properties - common properties to be shared by all channel instances generated by an instance of factoryType

Security Roles:

     administrator
     operator


updateChannelFactoryProperty

public com.ibm.websphere.channel.framework.ChannelFactoryData updateChannelFactoryProperty(java.lang.Class type, java.lang.Object key, java.lang.Object value)

     Updates a single ChannelFactory property.

Parameters:

     type - channel factory class for which properties are to be associated
     key - key of the property
     value - value of the property

Security Roles:

     administrator
     operator


getChannelFactory

public com.ibm.websphere.channel.framework.ChannelFactoryData getChannelFactory(java.lang.Class type)

     Fetch an existing channel factory from the transport channel service.

Parameters:

     type - The class of the factory being queried

Security Roles:

     administrator
     operator


addChannel

public com.ibm.websphere.channel.framework.ChannelData addChannel(java.lang.String name, java.lang.Class factoryType, java.util.Map properties, int weight)

     creates a named channel data object and instantiates an instance of its channel factory (if one does not already exist).

Parameters:

     name -
     factoryType -
     properties -
     weight - for use by discrimination in inbound chains

Security Roles:

     administrator
     operator


addChannel

public com.ibm.websphere.channel.framework.ChannelData addChannel(java.lang.String name, java.lang.Class factoryType, java.util.Map properties)

     Creates a named channel data objet and instantiates an instance of its channel factory (if one does not already exist).

Parameters:

     name -
     factoryType -
     properties -

Security Roles:

     administrator
     operator


removeChannel

public com.ibm.websphere.channel.framework.ChannelData removeChannel(java.lang.String name)

     Remove a channel; if the channel is in use by the transport channel service, an exception will be thrown. In order to remove a channel, it must not be in use by the runtime.

Parameters:

     name -

Security Roles:

     administrator
     operator


updateChannelWeight

public com.ibm.websphere.channel.framework.ChannelData updateChannelWeight(java.lang.String name, int weight)

     Update the new discrimination weight to be used when this channel is running.

Parameters:

     name -
     weight -

Security Roles:

     administrator
     operator


updateChannelProperty

public com.ibm.websphere.channel.framework.ChannelData updateChannelProperty(java.lang.String name, java.lang.Object key, java.lang.Object value)

     Update a single property that is use by the input named channel. If the property already exists, it will overlay what is there.

Parameters:

     name -
     key -
     value -

Security Roles:

     administrator
     operator


updateAllChannelProperties

public com.ibm.websphere.channel.framework.ChannelData updateAllChannelProperties(java.lang.String name, java.util.Map properties)

     Update the entire set of properties in use by the input named channel.

Parameters:

     name -
     properties -

Security Roles:

     administrator
     operator


getChannel

public com.ibm.websphere.channel.framework.ChannelData getChannel(java.lang.String name)

     Returns a channel data object for a specific named channel.

Parameters:

     name -

Security Roles:

     administrator
     operator


getAllChannels

public com.ibm.websphere.channel.framework.ChannelData[] getAllChannels()

     Return the entire of set of channels that have been added via this interface's addChannel methods.

Security Roles:

     administrator
     operator


getRunningChannels

public com.ibm.websphere.channel.framework.ChannelData[] getRunningChannels()

     Return the entire of set of channels that have been added via this interface's addChannel methods and are in use by the runtime.

Security Roles:

     administrator
     operator


addChain

public com.ibm.websphere.channel.framework.ChainData addChain(java.lang.String name, com.ibm.websphere.channel.framework.FlowType type, java.lang.String[] channels)

     Create a specific named chain and the structures to prepare this chain to be created. It assumes that channels already exist for the names in the channel list.

Parameters:

     name - unique name for the new chain to be created
     type -
     channels - list of names representing the channels to be added to this chain

Security Roles:

     administrator
     operator


addChain

public com.ibm.websphere.channel.framework.ChainData addChain(java.lang.String name, com.ibm.websphere.channel.framework.FlowType type, java.lang.String[] channels, java.lang.String acceptorID)

     Create a specific named chain and the structures to prepare this chain to be created. It assumes that channels already exist for the names in the channel list.

Parameters:

     name - unique name for the new chain to be created
     type -
     channels - list of names representing the channels to be added to this chain
     acceptorID - unique identifier for the runtime object which will ultimately receive requests from the chain created by this method

Security Roles:

     administrator
     operator


removeChain

public com.ibm.websphere.channel.framework.ChainData removeChain(java.lang.String name)

     Remove a chain. If it is in use by the runtime, an exception will be thrown. All channels in the chain will be destroyed if not in use by another chain.

Parameters:

     name -

Security Roles:

     administrator
     operator


updateChain

public com.ibm.websphere.channel.framework.ChainData updateChain(java.lang.String name, java.lang.String[] channels)

     Updates a chain with a new set of channels. If it is in use by the runtime, an exception will be thrown.

Parameters:

     name - name of the chain to update
     channels - new list of named channels for the chain

Security Roles:

     administrator
     operator


getChain

public com.ibm.websphere.channel.framework.ChainData getChain(java.lang.String name)

     

Parameters:

     name -

Security Roles:

     administrator
     operator


getAllChains

public com.ibm.websphere.channel.framework.ChainData[] getAllChains()

     

Security Roles:

     administrator
     operator


getAllChains

public com.ibm.websphere.channel.framework.ChainData[] getAllChains(java.lang.String channelName)

     Fetch all chains in the transport channel service which include the given channel.

Parameters:

     channelName - return all chains that contain this named channel

Security Roles:

     administrator
     operator


getAllChains

public com.ibm.websphere.channel.framework.ChainData[] getAllChains(java.lang.Class factoryClass)

     Fetch all chains in the transport channel service that include channels created from the given factory class.

Parameters:

     factoryClass - return all chains that contain a channel created with this class

Security Roles:

     administrator
     operator


getRunningChains

public com.ibm.websphere.channel.framework.ChainData[] getRunningChains()

     Fetch all chains in the transport channel service that have been initialized and are currently running.

Security Roles:

     administrator
     operator


getRunningChains

public com.ibm.websphere.channel.framework.ChainData[] getRunningChains(java.lang.String channelName)

     Fetch all chains in the transport channel service that have been initialized and are currently running which include the given channel.

Parameters:

     channelName -

Security Roles:

     administrator
     operator


getRunningChains

public com.ibm.websphere.channel.framework.ChainData[] getRunningChains(java.lang.Class factoryClass)

     Fetch all chains in the transport channel service that have been initialized and are currently running which include a channel created by the given factory.

Parameters:

     factoryClass -

Security Roles:

     administrator
     operator


startChain

public void startChain(java.lang.String name)

     

Parameters:

     name -

Security Roles:

     administrator
     operator


stopChain

public void stopChain(java.lang.String name, long delay)

     

Parameters:

     name -
     delay -

Security Roles:

     administrator
     operator


startChainsByAcceptorID

public void startChainsByAcceptorID(java.lang.String acceptorID)

     This method will start all enabled inbound chains associated with a given acceptor object. When calling this method, an acceptor should provide its well-known identifier, based on whatever data the associated acceptor channel factory uses to determine the acceptor for a given channel instance.

Parameters:

     acceptorID -

Security Roles:

     administrator
     operator


stopChainsByAcceptorID

public void stopChainsByAcceptorID(java.lang.String acceptorID, long delay)

     This method will stop all running inbound chains associated with a given acceptor object. When calling this method, an acceptor should provide its well-known identifier, based on whatever data the associated acceptor channel factory uses to determine the acceptor for a given channel instance.

Parameters:

     acceptorID -
     delay -

Security Roles:

     administrator
     operator


getEndPoint

public com.ibm.wsspi.channel.framework.CFEndPoint getEndPoint(java.lang.String name)

     Fetch the CFEndPoint representation of the given inbound chain. If the chain cannot be found, null is returned.

Parameters:

     name - name of the running inbound chain for which a CFEndPoint should be generated

Security Roles:

     administrator
     operator


getEndPointsByAcceptorID

public com.ibm.wsspi.channel.framework.CFEndPoint[] getEndPointsByAcceptorID(java.lang.String acceptorID)

     Fetch all CFEndPoint representations for the chains that match the given acceptor identifier. If the acceptor ID is unknown null will be returned.

Parameters:

     acceptorID - well-known identifier for the acceptor calling this method

Security Roles:

     administrator
     operator


Copyright IBM Corporation 2002, 2012