Work with object cache properties files

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

Determine the changes to make to the object cache 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 an object cache instance. We can also create, modify, or delete object cache custom properties.

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

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

• Create or edit an ObjectCacheInstance properties file.

  1. Set ObjectCacheInstance properties as needed.

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

     #
     # Header
     #
     ResourceType=ObjectCacheInstance
     ImplementingResourceType=ObjectCacheInstance
     ResourceId=Cell=!{cellName}:Node=!{nodeName}:Server=!{serverName}:CacheProvider=myCacheProvider:
     ObjectCacheInstance=jndiName#myObjectCacheJndiName  #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=myObjectCacheJndiName # required
     enableDiskOffload=false #boolean, required,default(false)
     replicationType=NONE #ENUM(PULL|PUSH|PUSH_PULL|NONE),default(NONE)
     category=null
     ENUM=null
     description=null
     disableDependencyId=false #boolean,default(false)
     #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=myObjectCache # required
     #
     EnvironmentVariablesSection
     #
     #
     #Environment Variables
     cellName=myCell04
     serverName=odr
     nodeName=myNode03

  2. Run the applyConfigProperties command to change an object 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 '])

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

  • To delete the entire instance, 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 object cache instance and its properties.

What to do next

Save the changes to the configuration.

Subtopics

• Work with object cache J2EE resource properties files
  We can use properties files to create, modify, or delete object cache J2EE resource custom properties.

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)