com.highdeal.admin.hci

Class CleanupAllOp

java.lang.Object

com.highdeal.admin.hci.CleanupAllOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class CleanupAllOp
extends java.lang.Object
implements MessageOperation

This operation allows you to trigger the cleanup of all subscriptions and provider contracts that are involved in session-based charging operations or in prerating operations (deprecated).

The SAP CC system resends a message to all rater instances for cleaning the subscriptions managed by each of them. Each rater instance cleans up all expired recurring events until the specified toDate for all charge activations of the given subscription.

In addition, a maxThroughput can be provided to control the resources used by each rater instance to perform the cleanup to preserve performance level for the usage rating. The unit represents the number of subscriptions cleaned per second for each rater instance. 0, the default value means that no limitation is applied. A negative value will be ignored and the throughput will be set to 0.

If some attributes are missing then a CleanupException is thrown.

This operation returns a CleanupAllResult that contains an execution status (performed, stopped, or incomplete) and the total count of cleaned subscriptions and contracts.

Related Information

See the SAP CC Admin+ user interface and the start_cleanup command.

Operation Result

CleanupAllResult

Operation Failure Exceptions

• CleanupException
• ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="cleanupAll">
   <xs:complexType>
     <xs:attribute name="maxThroughput" type="xs:integer" default="0"/>
     <xs:attribute name="toDate" type="xs:dateTime" use="required"/>
   </xs:complexType>
 </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:

Edition	Final Target Instances
	rater	updater	guider	bulkLoader	taxer	dispatcher
charge	No	No	No	No	No	Yes

Audit Domain

This operation is audited by the system as part of the audit domain: ADMINISTRATION. Consult the IT administrator.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: "cleanupAll"

Constructor Summary

Constructors

Constructor and Description
CleanupAllOp() Constructs an empty CleanupAll Operation.

Method Summary

Modifier and Type	Method and Description
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.
int	getMaxThroughput() Returns the max throughput (max number of expired subscription cleaned per second into each rater instance).
java.lang.String	getName() The name of this operation is "cleanupAll".
java.util.Date	getToDate() Gets the to date for this cleanupAll 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.
void	setMaxThroughput(int val) Sets the maximum throughput.
void	setToDate(java.util.Date toDate) Sets the to date for this cleanupAll operation.

Methods inherited from class java.lang.Object

equals, 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: "cleanupAll"

See Also:

Constant Field Values

Constructor Detail

CleanupAllOp

public CleanupAllOp()

Constructs an empty CleanupAll Operation.

Method Detail

getName

public java.lang.String getName()

The name of this operation is "cleanupAll".

Specified by:

getName in interface MessageOperation

Returns:

"cleanupAll"

getToDate

public java.util.Date getToDate()

Gets the to date for this cleanupAll operation.

Returns:

The to date for this cleanupAll operation

setToDate

public void setToDate(java.util.Date toDate)

Sets the to date for this cleanupAll operation.

Parameters:

toDate - The to date for this cleanupAll operation

getMaxThroughput

public int getMaxThroughput()

Returns the max throughput (max number of expired subscription cleaned per second into each rater instance).

Returns:

The max throughput

setMaxThroughput

public void setMaxThroughput(int val)

Sets the maximum throughput. A negative value is considered like 0 (no limitation).

Parameters:

val - The value of the maxThroughput

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

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

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

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