com.highdeal.admin.hci

Class ServerShutdownOp

java.lang.Object

com.highdeal.admin.hci.ServerManagementOp

com.highdeal.admin.hci.ServerShutdownOp

All Implemented Interfaces:

MessageOperation, XMLMarshallable

public class ServerShutdownOp
extends ServerManagementOp

This operation allows you to stop a specific instance in the connected SAP CC Core Server system.

Operation Result

ServerShutdownResult

Operation Failure Exception

ServerFailureException

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="serverShutdown">
   <xs:complexType>
     <xs:attribute name="opID" type="xs:string"/>
     <xs:attribute name="delay" type="xs:integer"/>
   </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	Yes	Yes	Yes	Yes	Yes	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 int	DEFAULT_DELAY Constant for the default delay: 0
static java.lang.String	OPERATION_NAME The XML tag name of this service operation: serverShutdown

Fields inherited from class com.highdeal.admin.hci.ServerManagementOp

OPERATION_ID, SERVER_NAME

Constructor Summary

Constructors

Constructor and Description
ServerShutdownOp()

Method Summary

Modifier and Type	Method and Description
int	getDelay() Returns the delay before the shutdown.
java.lang.String	getName() Returns the name of the operation: "serverShutdown"
void	setDelay(int d)

Methods inherited from class com.highdeal.admin.hci.ServerManagementOp

addCharacterData, addChild, getServerName, marshal, setAttributes, setServerName

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: serverShutdown

See Also:

Constant Field Values

DEFAULT_DELAY

public static final int DEFAULT_DELAY

Constant for the default delay: 0

See Also:

Constant Field Values

Constructor Detail

ServerShutdownOp

public ServerShutdownOp()

Method Detail

getName

public java.lang.String getName()

Returns the name of the operation: "serverShutdown"

Specified by:

getName in interface MessageOperation

Specified by:

getName in class ServerManagementOp

Returns:

"serverShutdown"

getDelay

public int getDelay()

Returns the delay before the shutdown.

Returns:

The delay

setDelay

public void setDelay(int d)