Package com.highdeal.admin.hci

Class GetLogTracesOp

java.lang.Object
com.highdeal.admin.hci.GetLogTracesOp
All Implemented Interfaces:
MessageOperation, XMLMarshallable
public class GetLogTracesOp extends Object implements MessageOperation
This operation allows you to retrieve the 50 latest logs and traces recorded in files by the instance of the SAP CC Core Server system that receives this operation request.

You can specify:

  • The number of returned entries (see maxCount); Maximum 1,000 entries or 500,000 characters can be retrieved.
  • A particular logging destination fileset (LDF1 to LDF5) according to the configuration of your SAP CC Core Server system.

Additional Information

For more information, consult the product documentation of SAP Convergent Charging:
  • See the SAP CC Application Help about the logging and the tracing functions
  • See the System Parameter Reference about the configuration of the system

Operation Result

GetLogTracesResult

Operation Failure Exceptions

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="getLogTraces">
   <xs:complexType>
     <xs:attribute name="maxCount" type="xs:integer" default="50"/>
     <xs:attribute name="destinationId" type="LoggingFileDestinationId" default="LDF1"/>
   </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:

EditionFinal Target Instances
raterupdaterguiderbulkLoadertaxerdispatcher
chargeYesYesYesYesYesYes

  • Field Details

    • OPERATION_NAME

      public static final String OPERATION_NAME
      The XML tag name of this service operation: getLogTraces
      See Also:

    • MAX_COUNT_NAME

      public static final String MAX_COUNT_NAME
      XML mapping for the MAX COUNT: "maxCount"
      See Also:

  • Constructor Details

    • GetLogTracesOp

      public GetLogTracesOp()

  • Method Details

    • getName

      public String getName()
      Returns the name of the operation.
      Specified by:
      getName in interface MessageOperation
      Returns:
      OPERATION_NAME

    • setLogTracesMaxCount

      public void setLogTracesMaxCount(int count)
      Sets the maximum count of log or trace entries to be retrieved.
      Parameters:
      count - The maximum count to be retrieved

    • getLogTracesMaxCount

      public int getLogTracesMaxCount()
      Gets the maximum count of log traces to be retrieved.
      Returns:
      The maximum count to be retrieved

    • getLoggingFileDestinationId

      public GetLogTracesOp.LoggingFileDestinationId getLoggingFileDestinationId()
      Gets the logging file destination to get log and/or trace messages from.
      Returns:
      The logging file destination

    • setLoggingFileDestinationId

      public void setLoggingFileDestinationId(GetLogTracesOp.LoggingFileDestinationId setLoggingFileDestinationId)
      Sets the logging file destination to get log and/or trace messages from.
      Parameters:
      setLoggingFileDestinationId - The logging file destination

    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Sets the operation attributes from the XMLAttributes.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XMLAttributes containing the data

    • addCharacterData

      public void addCharacterData(String cData)
      Adds string data to this operation.

      This data is ignored for this operation.

      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to add to the operation

    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Adds a child tag to this operation.

      This tag is ignored for this operation.

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

    • marshal

      public void marshal(XMLOutputter output)
      Writes the operation XML data to the specified output.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XMLOutputter to write into