Work with web container properties files

Use properties files to change web container properties and associated stateManagement and threadPool attributes under a server.

Determine the changes to make to your Web container configuration.

Run: wsadmin -lang jython

Use a properties file to create, modify, or delete a web container configuration properties.

Run administrative commands using wsadmin to change a properties file for a web container, validate the properties, and apply them to the configuration.

Action	Procedure
create	Not applicable
modify	Edit properties and then run the applyConfigProperties command.
delete	Not applicable
create Property	Set properties and then run the applyConfigProperties command.
delete Property	Properties to delete in the properties file and then run the deleteConfigProperties command.

Optionally, we can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Tasks

• Create web container properties.

  1. Specify WebContainer properties in a properties file.

     Open an editor and specify web container properties WebContainer and associated stateManagement and threadPool attributes under a server in a properties file. We can copy the following example properties into an editor and modify the properties as needed for our situation. The example shows a property under WebContainer with name myName and value myVal.

     #
     # SubSection 1.0 # WebContainer Component
     #
     ResourceType=WebContainer
     ImplementingResourceType=WebContainer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:WebContainer=
     AttributeInfo=components
     #
     
     #
     #Properties
     #
     enableServletCaching=false #boolean,default(false)
     name=null
     defaultVirtualHostName=null
     server=null
     maximumPercentageExpiredEntries=15 #integer,default(15)
     asyncIncludeTimeout=60000 #integer,default(60000)
     parentComponent=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer= #ObjectName(ApplicationServer),readonly
     disablePooling=false #boolean,default(false)
     apiDiscovery=false #boolean,default(false)
     sessionAffinityFailoverServer=null
     maximumResponseStoreSize=100 #integer,default(100)
     allowAsyncRequestDispatching=false #boolean,default(false)
     sessionAffinityTimeout=0 #integer,default(0)
     
     
     #
     # SubSection 1.0.1 # WebContainer State Management #
     ResourceType=StateManageable
     ImplementingResourceType=WebContainer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:WebContainer=:StateManageable=
     AttributeInfo=stateManagement
     #
     
     #
     #Properties
     #
     initialState=START #ENUM(STOP|START),default(START)
     managedObject=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:WebContainer= #ObjectName(WebContainer),readonly
     
     
     #
     # SubSection 1.0.3 # WebContainer ThreadPool
     #
     ResourceType=ThreadPool
     ImplementingResourceType=WebContainer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:WebContainer=:ThreadPool=
     AttributeInfo=threadPool
     #
     
     #
     #Properties
     #
     maximumSize=10 #integer,required,default(5)
     name=null
     minimumSize=0 #integer,required,default(1)
     inactivityTimeout=50 #integer,required,default(5000)
     description=null
     isGrowable=false #boolean,default(false)
     
     
     #
     # SubSection 1.0.3.1 # WebContainer properties #
     ResourceType=ThreadPool
     ImplementingResourceType=WebContainer
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:ApplicationServer=:WebContainer=:ThreadPool=
     AttributeInfo=customProperties(name,value)
     #
     
     #
     #Properties
     #
     myName=myVal
     #
     
     EnvironmentVariablesSection
     #
     #Environment Variables
     cellName=WASCell06
     serverName=myServer
     nodeName=WASNode04
     

  2. Run the applyConfigProperties command to create a WebContainer 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 existing web container properties.
  1. Obtain a properties file for the web container to change.

     We can extract a properties file for a WebContainer 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.

• Delete the web container properties.

  To delete one or more properties, specify only those properties to delete in the properties file and run deleteConfigProperties.

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

Use the properties file to configure and manage the web container object.

What to do next

Save the changes to the configuration.

Subtopics

• Work with web container session manager properties files
  Use properties files to change session manager properties under the web container and associated tuningParams, sessionDatabasePersistence, and defaultCookieSettings attributes under a server.

Extracting properties files

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

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

Discovering REST API documentation

PropertiesBasedConfiguration .