Package com.highdeal.admin.hci

Class SQLConnectionAdminOp

java.lang.Object
com.highdeal.admin.hci.SQLConnectionAdminOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class SQLConnectionAdminOp extends Object implements MessageOperation
This operation allows you to manually reconnect or disconnect an SQL connection of the targeted system instance(s). It can only be used in an high availability (HA) system connected with multiple database instances.
See Also:

Operation Result

SQLConnectionAdminResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="sqlConnectionAdmin">
   <xs:complexType>
     <xs:attribute name="dbScope" type="DatabaseScopeType" default="core" />
     <xs:attribute name="uri" type="xs:integer" />
     <xs:attribute name="operation" type="sqlConnectionOperation" default="reconnect"/>
   </xs:complexType>
 </xs:element>

 <xs:simpleType name="DatabaseScopeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="core"/>
     <xs:enumeration value="session"/>
   </xs:restriction>
 </xs:simpleType>

 <xs:simpleType name="sqlConnectionOperation">
   <xs:restriction base="xs:string">
     <xs:enumeration value="reconnect"/>
     <xs:enumeration value="disconnect"/>
     <xs:enumeration value="status"/>
   </xs:restriction>
 </xs:simpleType>

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

Audit Domain

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

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML name of this service operation: "sqlConnectionAdmin"
      See Also:

    • RECONNECT

      public static final String RECONNECT
      The operation for the reconnection of an SQL connection.

    • DISCONNECT

      public static final String DISCONNECT
      The operation for the disconnection of an SQL connection.

    • STATUS

      public static final String STATUS

  • Constructor Details

    • SQLConnectionAdminOp

      public SQLConnectionAdminOp()
      Creates an SQL connection administration operation.

  • Method Details

    • getName

      public 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(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(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

    • isReconnectOperation

      public boolean isReconnectOperation()
      Retrieves whether the operation to perform on the selected SQL connection is a reconnection operation.
      Returns:
      true if the operation to perform on the selected SQL connection is a reconnection operation, false otherwise

    • getAdminOperation

      public String getAdminOperation()
      Retrieves the operation to perform on the selected SQL connection.

      The possible values are:

      • RECONNECT: reconnection of the selected SQL connection
      • DISCONNECT: disconnection of the selected SQL connection

      Returns:
      The operation to perform on the SQL connection (RECONNECT or DISCONNECT)

    • setAdminOperation

      public void setAdminOperation(String operation)
      Specifies the operation to perform on the selected SQL connection.

      The possible values are:

      • RECONNECT: reconnection of the selected SQL connection
      • DISCONNECT: disconnection of the selected SQL connection
      • STATUS: status of the selected SQL connection

      Parameters:
      operation - The operation to perform on the SQL connection (RECONNECT or DISCONNECT or STATUS)

    • getUriId

      public int getUriId()
      Retrieves the index of the JDBC URI corresponding to the SQL connection to manage.
      Returns:
      The index of the JDBC URI corresponding to the SQL connection to manage (possible values are numbers from 1 to 12)

    • setUri

      public void setUri(int uri)
      Specifies the index of the JDBC URI corresponding to the SQL connection to manage.
      Parameters:
      uri - The index of the JDBC URI corresponding to the SQL connection to manage (allowed values are numbers from 1 to 12, but the value must not exceed the number of SQL connections configured in the system)

    • getDatabaseScope

      public SQLConnectionAdminOp.DatabaseScope getDatabaseScope()
      Retrieves the scope of the back-end database.
      Returns:
      The scope of the database

    • setDatabaseScope

      public void setDatabaseScope(SQLConnectionAdminOp.DatabaseScope dbScope)
      Specifies the scope of the back-end database.
      Parameters:
      dbScope - The scope of the database