com.highdeal.admin.hci
Class StartCacheWarmupOp

java.lang.Object
  extended by com.highdeal.admin.hci.StartCacheWarmupOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable

public class StartCacheWarmupOp
extends java.lang.Object
implements MessageOperation

This operation allows you to force the start of the cache warm-up process in the instances of the connected SAP CC Core Server system.

Implementation Example

This HCI operation is available in the SAP CC Admin+ user interface. Refer to the start_cache_warmup command.

Note

Consult the SAP CC Library (Application Help) documentation for more information about the data cache warm-up mechanism.

Operation Result

StartCacheWarmupResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="startCacheWarmup">
 </xs:element>

Operation Availability

You can send this operation request in HCI messages to the following final target types of instances in the connected SAP CC system:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeNoNoNoNoNoYes

Field Summary
static java.lang.String OPERATION_NAME
          The XML tag name of this service operation: "startCacheWarmup"
 
Constructor Summary
StartCacheWarmupOp()
           
 
Method Summary
 void addCharacterData(java.lang.String cData)
          Adds character data to the content element.
 void addChild(java.lang.String tagName, XMLMarshallable child)
          Adds a child to the object, the child representing the marshallable object which must be added to the element.
 java.lang.String getName()
          Gets the XML name of the service operation.
 void marshal(XMLOutputter output)
          Gives an XML representation of this object, including its children.
 void setAttributes(XMLAttributes atts)
          Sets the attributes of the XML representation of the element being processed.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OPERATION_NAME

public static final java.lang.String OPERATION_NAME
The XML tag name of this service operation: "startCacheWarmup"

See Also:
Constant Field Values
Constructor Detail

StartCacheWarmupOp

public StartCacheWarmupOp()
Method Detail

getName

public java.lang.String getName()
Description copied from interface: MessageOperation
Gets the XML name of the service operation. This name identifies the operation request in the HCI messages. It is used to marshal the Java object representing an HCI operation into an XML representation that can be exchanged via the HCI communication interface between your client application and the SAP CC system.

Example

  • activateAll
  • ping

Specified by:
getName in interface MessageOperation
Returns:
The technical name of the HCI operation

setAttributes

public void setAttributes(XMLAttributes atts)
Description copied from interface: XMLMarshallable
Sets the attributes of the XML representation of the element being processed.

Specified by:
setAttributes in interface XMLMarshallable
Parameters:
atts - The XML attributes of the current element

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)
Description copied from interface: XMLMarshallable
Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:
addChild in interface XMLMarshallable
Parameters:
tagName - The name of tag for the child
child - The child to be added

addCharacterData

public void addCharacterData(java.lang.String cData)
Description copied from interface: XMLMarshallable
Adds character data to the content element.

Specified by:
addCharacterData in interface XMLMarshallable
Parameters:
cData - The character data to be added

marshal

public void marshal(XMLOutputter output)
Description copied from interface: XMLMarshallable
Gives an XML representation of this object, including its children.

Specified by:
marshal in interface XMLMarshallable
Parameters:
output - The XML output to marshal the object into

Document Published: October 2015 (SAP CC 4.0 SP10 and Later)