ChannelFrameworkManagement command group for the AdminTask object

You can use the Jython or Jacl scripting languages to configure security. The commands and parameters in the ChannelFrameworkManagement group can be used to create and manage transport channels and transport channel chains.

The ChannelFrameworkManagement command group for the AdminTask object includes the following commands:

createChain

The createChain command creates a new chain of transport channels that are based on a chain template.

Target object

The instance of the transport channel service under which the new chain is created. (ObjectName, required)

Required parameters and return values

-template
The chain template on which to base the new chain. (ObjectName, required)
-name
The name of the new chain. (String, required)
-endPoint
The name of the end point to be used by the instance of the TCP inbound channel in the new chain if the chain is an inbound chain. (ObjectName, optional)

Examples

Batch mode example usage:

  • Using Jacl:
    $AdminTask createChain (cells/rohitbuildCell01/nodes/ 
     rohitbuildCellManager01/servers/dmgr|server.xml#  TransportChannelService_1) {-template WebContainer 
     (templates/chains|webcontainer-chains.xml#Chain_1)   -name trialChain1 }
    $AdminTask createChain (cells/rohitbuildCell01/nodes/ 
     rohitbuildCellManager01/servers/dmgr|server.xml# TransportChannelService_1)  {-template WebContainer 
     (templates/chains|webcontainer-chains.xml#Chain_1)  -name trialChain1 -endPoint  (cells/rohitbuildCell01/ 
     nodes/rohitbuildCellManager01|serverindex.xml#EndPoint_3) }
  • Using Jython string:
     AdminTask.createChain('cells/rohitbuildCell01/nodes/ 
     rohitbuildCellManager01/servers/dmgr|server.xml# TransportChannelService_1',  '[-template "WebContainer 
     (templates/chains|webcontainer-chains.xml#Chain_1)"  -name trialChain]')
    AdminTask.createChain('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/ 
     servers/dmgr|server.xml#TransportChannelService_1',  '[-template  "WebContainer(templates/chains|webcontainer-chains. 
     xml#Chain_1)" -name trialChain -endPoint "(cells/  
     rohitbuildCell01/nodes/rohitbuildCellManager01|serverindex.xml#EndPoint_3)"]')
  • Using Jython list:
    AdminTask.createChain('cells/rohitbuildCell01/nodes/ 
     rohitbuildCellManager01/servers/dmgr|server.xml# TransportChannelService_1',  ['-template', "WebContainer 
     (templates/chains|webcontainer-chains.xml#Chain_1)",  '-name', 'trialChain'])
    AdminTask.createChain('cells/rohitbuildCell01/nodes/rohitbuildCellManager01/ 
     servers/dmgr|server.xml#TransportChannelService_1',  ['-template',  "WebContainer(templates/chains|webcontainer-chains. 
     xml#Chain_1)", '-name', 'trialChain', '-endPoint',  "(cells/ 
     rohitbuildCell01/nodes/rohitbuildCellManager01|serverindex.xml#EndPoint_3)"])

Interactive mode example usage:

  • Using Jacl:
    $AdminTask createChain {-interactive}
  • Using Jython string:
    AdminTask.createChain ('[-interactive]')
  • Using Jython list:
    AdminTask.createChain (['-interactive'])

deleteChain

The deleteChain command deletes an existing chain and, optionally, the transport channels in the chain.

Target object

The chain to be deleted. (Object name, required)

Required parameters and return values

-deleteChannels
If the value of this attribute is true, non-shared transport channels used by the specified chain will be deleted. (Boolean, optional)

Examples

Batch mode example usage:

  • Using Jacl:
    $AdminTask deleteChain 
     trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr |server.xml#Chain_1093554462922)
    $AdminTask deleteChain 
     trialChain(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr |server.xml#Chain_1093554378078) {-deleteChannels 
     true}
  • Using Jython string:
    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr 
     |server.xml#TransportChannelService_1)')
    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr 
     |server.xml#TransportChannelService_1)', '[-deleteChannels true]')
  • Using Jython list:
    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr 
     |server.xml#TransportChannelService_1)')
    AdminTask.deleteChain('trialChain1(cells/rohitbuildCell01/nodes/rohitbuildCellManager01/servers/dmgr 
     |server.xml#TransportChannelService_1)', ['-deleteChannels', 'true'])

Interactive mode example usage:

  • Using Jacl:
    $AdminTask deleteChain {-interactive}
  • Using Jython string:
    AdminTask.deleteChain ('[-interactive]')
  • Using Jython list:
    AdminTask.deleteChain (['-interactive'])

listChainTemplates

The listChainTemplates command displays a list of templates that you can use to create chains in this configuration. All templates have a certain type of transport channel as the last transport channel in the chain.

Target object

None

Required parameters and return values

-acceptorFilter
The templates returned by this method all have a transport channel instance of the specified type as the last transport channel in the chain. (String, optional)

Examples

Batch mode example usage:

  • Using Jacl:
    $AdminTask listChainTemplates {}
    $AdminTask listChainTemplates "-acceptorFilter WebContainerInboundChannel"
  • Using Jython string:
    AdminTask.listChainTemplates()
    AdminTask.listChainTemplates('[-acceptorFilter WebContainerInboundChannel]')
  • Using Jython list:
    AdminTask.listChainTemplates()
    AdminTask.listChainTemplates(['-acceptorFilter', 'WebContainerInboundChannel'])

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listChainTemplates {-interactive}
  • Using Jython string:
    AdminTask.listChainTemplates ('[-interactive]')
  • Using Jython list:
    AdminTask.listChainTemplates (['-interactive'])

listChains

The listChains command lists all the chains that are configured under a particular instance of the transport channel service.

Target object

The instance of the transport channel service under which the chains are configured. (ObjectName, required)

Required parameters and return values

-acceptorFilter
The chains that are returned by this parameter will have a transport channel instance of the type that you specify as the last transport channel in the chain. (String, optional)
-endPointFilter:
The chains returned by this parameter will have a TCP inbound channel using an end point with the name that you specify.(String, optional)

Examples

Batch mode example usage:

  • Using Jacl:
    $AdminTask listChains (cells/rohitbuildCell01/nodes/ rohitbuildNode01/servers/server2|server.xml# 
      TransportChannelService_1093445762328)
    $AdminTask listChains (cells/rohitbuildCell01/nodes/ rohitbuildNode01/servers/server2|server.xml# 
      TransportChannelService_1093445762328) {-acceptorFilter  WebContainerInboundChannel}
    $AdminTask listChains (cells/rohitbuildCell01/nodes/ rohitbuildNode01/servers/server2|server.xml# 
      TransportChannelService_1093445762328)  {-endPointFilter WC_adminhost}
  • Using Jython string:
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)')
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)', '[-acceptorFilter WebContainerInboundChannel]')
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)', '[-endPointFilter WC_adminhost]')
  • Using Jython list:
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)')
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)', ['-acceptorFilter', 'WebContainerInboundChannel'])
    AdminTask.listChains('(cells/rohitbuildCell01/nodes/rohitbuildNode01/servers/server2|server.xml 
     #TransportChannelService_1093445762328)', ['-endPointFilter', 'WC_adminhost'])

Interactive mode example usage:

  • Using Jacl:
    $AdminTask listChains {-interactive}
  • Using Jython string:
    AdminTask.listChains ('[-interactive]')
  • Using Jython list:
    AdminTask.listChains (['-interactive'])