Work with servlet cache properties files

We can use properties files to create, modify, or delete servlet cache properties and custom properties.

Determine the changes to make to the servlet cache configuration or its configuration objects.

From the server profile bin directory, run wsadmin -lang jython

Using a properties file, we can create, modify, or delete a servlet cache instance. We can also create, modify, or delete servlet cache custom properties.

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

properties files. We can create, modify, and delete

Action	Procedure
create	Set required properties and then run the applyConfigProperties command.
modify	Edit properties and then run the applyConfigProperties command to modify the value of a custom property.
delete	Run the deleteConfigProperties command to delete a property. If the deleted property has a default value, the property is set to the default value. To delete the entire ServletCacheInstance object, uncomment #DELETE=true and then 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')

1. Create or edit a servlet cache properties file.

   1. Set ServletCacheInstance properties as needed.

      Open an editor on a ServletCacheInstance properties file. Modify the Environment Variables section to match the system and set any property value that needs to be changed. An example ServletCacheInstance properties file follows:

      #
      # Header
      #
      ResourceType=ServletCacheInstance
      ImplementingResourceType=ServletCacheInstance
      ResourceId=Cell=!{cellName}:CacheProvider=myCacheProvider:ServletCacheInstance=jndiName#myServletCacheJndiName
      #DELETE=true
      #
       #
      #Properties
      #
      diskCacheEntrySizeInMB=0 #integer,default(0)
      defaultPriority=1 #integer, required,default(1)
      useListenerContext=false #boolean,default(false)
      pushFrequency=1 #integer,default(1)
      memoryCacheSizeInMB=0 #integer,default(0)
      hashSize=1024 #integer,default(1024)
      providerType=null
      diskCacheSizeInEntries=0 #integer,default(0)
      diskOffloadLocation=null
      diskCacheSizeInGB=0 #integer,default(0)
      enableCacheReplication=false #boolean,default(false)
      cacheSize=2000 #integer, required,default(2000)
      jndiName=myServletCacheJndiName # required
      enableDiskOffload=false #boolean, required,default(false)
      replicationType=NONE #ENUM(PULL|PUSH|PUSH_PULL|NONE),default(NONE)
      category=null
      description=null
      #provider=CacheProvider#ObjectName(CacheProvider),readonly
      diskCacheCleanupFrequency=0 #integer,default(0)
      referenceable=null
      flushToDiskOnStop=false #boolean,default(false)
      diskCachePerformanceLevel=BALANCED #ENUM(LOW|BALANCED|HIGH|CUSTOM),default(BALANCED)
      name=myServletCache # required
      #
      EnvironmentVariablesSection
      #
      #
      #Environment Variables
      cellName=myCell04

   2. Run the applyConfigProperties command to create or change a servlet cache 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'])

2. If we no longer need the servlet cache or an existing custom property, we can delete the entire servlet cache object or the custom property.

   • 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 a custom property, specify only the property to be deleted in the properties file and then run the deleteConfigProperties command.

Results

We can use the properties file to configure and manage the servlet cache object and its properties.

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)