Work with listener port properties files

We can use properties files to create or change Message Listener Service listener port properties under a server and associated StateManageable objects.

Determine the changes to make to the listener port configuration or its configuration objects.

Start the wsadmin scripting tool. To start wsadmin using the Jython language, run the wsadmin -lang Jython command from the bin directory of the server profile.

Using a properties file, we can create, modify, or delete a listener port object and its configuration properties.

Run administrative commands using wsadmin to create or change a properties file for a listener port, validate the properties, and apply them to the configuration.

files. We can create, modify, and delete listener port

Action	Procedure
create	Set properties and then run the applyConfigProperties command.
modify	Edit properties and then run the applyConfigProperties command.
delete	Uncomment #DELETE=true and run the deleteConfigProperties command.
create Property	Not applicable
delete Property	Not applicable

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

• Create a listener port and its properties.

  1. Create ListenerPort properties in a properties file.

     Open an editor and specify listener port properties. We can copy the following example properties into an editor and modify the properties as needed for the situation. The example defines a listener port under the MessageListenerService under a server, and the associated StateManageable object.

     #
     # SubSection 1.0.0 # ListenerPort
     #
     ResourceType=ListenerPort
     ImplementingResourceType=GenericType
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:EJBContainer=
     :MessageListenerService=:ListenerPort=myName
     AttributeInfo=listenerPorts
     #DELETE=true
      #
     #Properties
     #
     destinationJNDIName=dName # required
     connectionFactoryJNDIName=myjName # required
     name=myName # required
     maxMessages=1 #integer,default(1)
     description=My description maxSessions=1 #integer,default(1)
     maxRetries=0 #integer,default(0)
      
     #
     # SubSection 1.0.0.0 # ListenerPort State Management #
     ResourceType=StateManageable
     ImplementingResourceType=GenericType
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:EJBContainer=
     :MessageListenerService=:ListenerPort=myName:StateManageable=
     AttributeInfo=stateManagement
     #
      #
     #Properties
     #
     initialState=START #ENUM(STOP|START),default(START)
     managedObject=myName
      EnvironmentVariablesSection
      #Environment Variables
     cellName=WASCell06
     serverName=myServer
     nodeName=WASNode04

  2. Run the applyConfigProperties command to create a listener port configuration.

     Running the applyConfigProperties command applies the properties file to the configuration. In this Jython example, the optional -reportFileName parameter produces a report named report.txt:

     AdminTask.applyConfigProperties(['-propertiesFileName myObjectType.props -reportFileName report.txt '])

• Modify an existing listener port.

  1. Obtain a properties file for the listener port to change.

     We can extract a properties file for a ListenerPort object using the extractConfigProperties command.

  2. Open the properties file in an editor and change the properties as needed.

     Ensure that the environment variables in the properties file match the system.

  3. Run the applyConfigProperties command to change a listener port configuration.

• If we no longer need a listener port, we can delete the entire listener port object.

  To delete the entire object, specify DELETE=true in the header section of the properties file and run the deleteConfigProperties command; for example:

  AdminTask.deleteConfigProperties('[-propertiesFileName myObjectType.props -reportFileName report.txt]')

Results

We can use the properties file to configure and manage the listener port.

What to do next

Save the changes to the configuration.

Related tasks

Extracting properties files

Create server, cluster, application, or authorization group objects using properties files and wsadmin scripting

Delete server, cluster, application, or authorization group objects using properties files

PropertiesBasedConfiguration (AdminTask)