Network Deployment (Distributed operating systems), v8.0 > Scripting the application serving environment (wsadmin) > Use properties files to manage system configuration > Manage specific configuration objects using properties files > Work with server properties files

Work with custom service properties files

We can use properties files to create or change custom service properties under a server.

Determine the changes to make to your custom service configuration or its configuration objects.

Start wsadmin.sh.

To start wsadmin using the Jython language, run...

WP_PROFILE/bin/wsadmin -lang jython

Use a properties file, you can create, modify, or delete a custom service object and its configuration properties.

Run administrative commands using wsadmin to create or modify a properties file for a custom service, validate the properties, and apply them to the configuration.

Actions for custom service properties files. You can create, modify, and delete custom service properties.

Action	Procedure
create	Set properties and then run applyConfigProperties.
modify	Edit properties and then run applyConfigProperties.
delete	Uncomment #DELETE=true and run deleteConfigProperties.
create Property	Set properties and then run applyConfigProperties.
delete Property	To delete one or more properties, run deleteConfigProperties with only those properties to delete in the properties file.

Optionally, you can use interactive mode with the commands:

AdminTask.command_name('-interactive')

Procedure

• Create a custom service and its properties.

  1. Create a properties file for a CustomService object.

     Open an editor and create a custom service properties file. We can copy the example properties file in this step into an editor and modify the properties as needed for your situation.

     An example properties file for a CustomService object under a server follows. A property under CustomService with a name of myName and a value of myVal is shown in the example:

     #
     # SubSection 1.0 # CustomService
     #
     ResourceType=CustomService
     ImplementingResourceType=CustomService
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:CustomService=displayName#mydisplayName
     AttributeInfo=customServices
     #DELETE=true
     
     #
     #Properties
     #
     displayName=mydisplayName #required
     classpath=myclasspath #required
     enable=false #boolean,default(false)
     externalConfigURL=null
     context=null
     description=null
     classname=mclass.name #required
     prerequisiteServices={} #ObjectName*(null)
     
     
     #
     # SubSection 1.0.1 # CustomService properties #
     ResourceType=CustomService
     ImplementingResourceType=CustomService
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:CustomService=displayName#mydisplayName
     AttributeInfo=properties(name,value)
     #
     
     #
     #Properties
     #
     myName=myVal
     
     EnvironmentVariablesSection
     
     #Environment Variables
     cellName=WASCell06
     serverName=myServer
     nodeName=WASNode04
     

  2. Run applyConfigProperties to create a CustomService configuration.

     Run applyConfigProperties 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 custom service.
  1. Obtain a properties file for the custom service that to change.

     We can extract a properties file for a CustomService 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 applyConfigProperties to change a custom service configuration.

• Delete the entire custom service object or its properties.

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

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

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

Results

We can use the properties file to configure and manage the custom service object.

What to do next

Save the changes to the configuration.
Extract properties files using wsadmin.sh
Validate properties files using wsadmin.sh
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
Create, modifying, and deleting configuration objects using one properties file

Related

Properties file syntax
PropertiesBasedConfiguration command group using wsadmin.sh

+

Search Tips   |   Advanced Search