You can use properties files to create or change custom
service properties under a server.
Before you begin
Determine the changes that you want to make to your custom
service 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.
About this task
Using 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 your configuration.
Table 1. Actions for custom service properties files. You
can create, modify, and delete custom service properties.
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 |
Set properties and then run the applyConfigProperties
command. |
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.
- Create a properties file for a CustomService object.
Open an editor and create a custom service properties file.
You 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
- Run the applyConfigProperties command to create a CustomService
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 custom service.
- Obtain a properties file for the custom service that
you want to change.
You can extract a properties file
for a CustomService using the extractConfigProperties command.
- Open the properties file in an editor and change the
properties as needed.
Ensure that the environment variables
in the properties file match your system.
- Run the applyConfigProperties command 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 the deleteConfigProperties
command; 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
You can use the properties file to configure and manage
the custom service object.
What to do next
Save the changes to your configuration.