Package com.highdeal.admin.hci

package com.highdeal.admin.hci

This Java package provides you with the classes for implementing the Administration Services from the HCI technical interface of SAP CC; With this package you can develop a client application able to manage the activation process, the cleanup process, system parameters, authorizations and roles for SAP CC users, troubleshooting operations.

Technical Interface	HCI (HTTP Communication Interface)
Communication Protocol	XML over HTTP (or HTTPS)
Communication Mode	Asynchronous, synchronous
Public Endpoints	http(s)://<DISPATCHER_INSTANCE_HOST>:<DISPATCHER_HCI_PORT_NUMBER>/admin/
API Technology	[x] Java [ ] SOAP [x] Proprietary XML
SAP CC Java Library	core-admin.jar
Security	Yes (see the SAP CC Security Guide)

Note

This Java package is part of the HCI technical interface provided by SAP Convergent Charging. See the main com.highdeal.hci package for more information.

Services and Operations

SAP Convergent Charging delivers some administration services that you can implement in your SAP system landscape:

• Business Services
• Technical Services

Business Services

Depending on your business requirements, you can implement the following operations in your client application to enable your end-to-end business scenarios:

Subareas	Service Operations
Billing Processes Synchronization Activation of periodic and one-off fees to prepare invoicing and billing	Activate all the subscriptions Activate provider contracts in mass
Performance Optimization	Cleanup all the contracts and subscriptions

Recommendation

Refer to the SAP CC Application Help for more information about the convergent charging and refilling services.

Technical Services

Depending on your business requirements, you can implement the following operations in your client application:

Subareas	Service Operations
Consultation of SAP CC Users: Authorization, Role	Search for an authorization Search for a role
Management of SAP CC Users	Delete an SAP CC user session Search for an SAP CC user session
Management of the SAP CC System	Shut down the SAP CC system Get a list of system parameters Set up the parameter value Reset a parameter value
Auditing the SAP CC System	Get the instance map of the SAP CC system Get the logs and traces from the SAP CC system Get the status of an instance in the running SAP CC system Get the status of the connected SAP CC system Get a parameter value Ping the SAP CC system
Troubleshooting	Delete an SAP CC user session Get the logs and traces from the SAP CC system Ping the SAP CC system Get the status of an instance in the running SAP CC system Get the status of the connected SAP CC system Get the thread dump Get a parameter value Refresh the rater instances Refresh the tax cache Refresh trans serv type list Refresh the VAT rule cache Reset the data caches File to bulk load Fire expiration alerts Purge idempotency storage

Implementation in Your Client Application

Java APIs

Your client application must send the message requests to the administrative URL of the dispatcher instances in the running SAP CC system. You must implement an AdminMessageSender.

Consider the following Java packages:

• com.highdeal.hci
• com.highdeal.hci.http and its method HttpMessageSenderFactory.createAdminMessageSender(java.lang.String)

Example

    HttpMessageSenderFactory factory = new HttpMessageSenderFactory();
    URL dispatcher = new URL("http://HOST:PORT/admin/");
    factory.init(dispatcher);
    MessageSender sender = factory.createAdminMessageSender(); // For admin operations that have to be executed on a dispatcher.
    // Or
    sender = factory.createAdminMessageSender("rater#1"); // For admin operations that have to be executed on a dedicated instance.
    // Take care that the admin operation is available on the targeted instance by using the static method AdminXMLMapping.getInstanceTypesByOperation(String opClassName)
    ...
    // Create a MessageEnvelope and add admin operation(s) in the message body.
    MessageEnvelope envelope;
    ...
    MessageEnvelope result = sender.send(envelope);
    ...
  

Recommendation

Most of the APIs in this Java package are implemented by the SAP CC Admin+ user interface.

To facilitate your development, you can view the messages exchanged between this user interface and the SAP CC system: use the debug command.

Communications

You use the HTTP Communication Interface (HCI) technical interface provided by SAP Convergent Charging.

Error and Exception Handling

Consider the exceptions depending on the service operations expected by your business requirements. Design and develop the appropriate exception handling.

Class	Description
ActivateAllOp	This mass operation allows triggering the Activation process on all the subscriptions in master data stored in SAP CC; It contains a reference date used to compute the periodic and one-off fees and to update all these subscriptions.
ActivateAllResult	This class represents the result of the Activate All operation or the Activate Charging Contract operation; It contains an overall execution status and the total count of processed subscriptions or provider contracts according to the operation requested.
ActiveUpdaterOperation	This class implements the targeted operation and it enables to target the active updater.
AdminCommandFailedResult
AdminParameterModel	The Java class represents a system parameter in the connected SAP CC system.
AdminXMLMapping	This Java class defines the mapping between XML tags and marshallable Java classes.
AuthorizationModel	This Java class represents an authorization that can be assigned to a role for SAP CC users; It contains the permissions for executable activities.
BadTargetException	Exception thrown when trying to access the value of a parameter that does not exist.
ChargingContractActivateOp	This mass operation allows you to trigger the Activation process on all the charging contracts (Concept: provider contracts) to compute the periodic and one-off fees; It contains a reference date used to compute the periodic and one-off fees and to update the contracts.
CleanupAllOp	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).
CleanupAllResult	This class represents the operation result of the Cleanup All operation; It includes an overall execution status.
ClientInfo	This Java class represents information about a charging client application or system that is connected to the SAP CC Core Server system; Implement the List Clients operation to handle this information in your client application.
ConstraintViolationException	This class implement the methods for the description of an unknown parameter exception.
CustomerManagementArea	FOR INTERNAL USE ONLY - This class represents a customer management area which is a pair of an SAP ERP and an SAP CRM system; The area includes a list of JCo destinations in charge of managing the customer data.
CustomerManagementAreaListModel	FOR INTERNAL USE ONLY - This class represents a list of customer management areas declared in the SAP CC system.
CustomerManagementAreasDefinitionListXMLMapping	FOR INTERNAL USE ONLY - This class defines the mapping between XML tags and the Customer Management Area List classes.
DeleteFileToBulkLoadOp	This operation allows you to delete a file to bulk load from the persistent system.
DeleteFileToBulkLoadResult	This operation result is returned when a bulk loading operation has successfully ended.
DeleteUserSessionOp	This operation allows you to delete a user session from the list of running user sessions. This operation can be used to delete a user session linked to a tool (user interface) that has been terminated abnormally and could not disconnect properly from the server system, thus preventing a new session to be opened with the same SAP CC user and tool. The identifier of the user session to delete must be specified in the sessionId attribute of the operation. If the session identifier of the user session is not set, or if the session identifier does not correspond to a running user session, an InvalidDeletionException with the reason does_not_exist will be thrown.
DeleteUserSessionResult	This operation result is sent in response to a Delete User Session operation when the user session has been successfully deleted.
DisconnectClientOp	This operation allows disconnecting the charging client connected to the SAP CC system.
DisconnectClientResult	This class represents the response of a Disconnect Client operation;
ExpirationAlertException	Exception thrown when the activation operation is invoked with invalid arguments.
FetchClientStatisticsException	Exception thrown when an error occurs while retrieving the statistics of a client connected to the SAP CC Core Server system (see the Fetch Client Statistics operation).
FetchClientStatisticsOp	This operation allows retrieving statistics about a charging client application connected to the SAP CC Core Server system; You specify the host and the communication port previously identified with the List Clients operation.
FetchClientStatisticsResult	This result contains statistics related to a charging client connected to the SAP CC system.
FileToBulkLoad	This Java class represents a file that was fetched by a rater instance and that is ready to be bulk loaded to another system.
FileToBulkLoad.FromInstanceType	This enumeration lists all the instance types from which the file is created (rater, bulkloader).
FireExpirationAlertsOp	This operation allows you to activate of alerts on expired subscriptions.
FireExpirationAlertsResult	This class represents the result of the Fire Expiration Alerts operation.
GetCustomerManagementAreaListOp	FOR INTERNAL USE ONLY - This operation allows you to retrieve the list of the customer management areas.
GetCustomerManagementAreaListResult	FOR INTERNAL USE ONLY - This operation contains the list of the customer management areas declared in SAP CC; Other areas can exist, but they are not defined in the SAP CC system.
GetFilesToBulkLoadOp	This operation allows you to get the list of files that are not yet bulk loaded.
GetFilesToBulkLoadResult	This operation result is returned when a bulk loading operation has successfully ended.
GetInstanceMapOp	This operation allows you to get the current instance map of the connected SAP CC system.
GetInstanceMapResult	This class represents the result of the Get Instance Map operation; It contains an instance map.
GetJCoDestinationListOp	FOR INTERNAL USE ONLY - This operation allows you to retrieve the list of the JCo destinations configured in the connected SAP CC system.
GetJCoDestinationListResult	FOR INTERNAL USE ONLY - This result contains the list of the configured JCo destinations.
GetLogTracesOp	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.
GetLogTracesOp.LoggingFileDestinationId	This enumeration lists all the identifiers of the fileset that contains the log and trace entries to retrieve.
GetLogTracesResult	This class represents the result of the Get Logs and Traces operation; It contains a Vector of the latest entries of the logs and traces of the responding instance of the SAP CC system.
GetParametersOp	This operation allows you to retrieve the list of the available administration parameters in the connected SAP CC system.
GetParametersResult	This class represents the result of the Get Parameters operation; It contains a Vector of parameters of the connected SAP CC system.
GetParameterValueOp	This operation allows you to retrieve the value of a parameter of the connected SAP CC system.
GetParameterValueResult	This Java class represents the result of the Get Parameter Value operation; It contains the information relating to the specified parameter.
GetStatusOp	This operation allows you to query the status of the instance of the SAP CC system that receives the request.
GetStatusResult	This class represents the result of the Get Status operation; It contains a status for the specified server instance.
GetSystemStatusOp	This operation allows you to retrieve the statuses (on, off, waiting) of each instance in the connected SAP CC system; The operation result is available in an overall system status.
GetSystemStatusResult	This class represents the result of the Get System Status operation; It contains an overall system status with the running status (starting, waiting, on, stopping, off) of each SAP CC system instance.
GetThreadDumpOp	This operation allows you to get the dump of all threads of an instance. The thread dump done by the JVM provides kernel information that the API doesn't, like: the kernel thread priority "prio" the kernel thread identifier "tid" the lock information So, the dump in the result of this operation: "prio" is the thread priority returned by the API "tid" is the hash of the thread (hexa) the lock information aren't returned The value of "tid" isn't the value returned to the method Thread.getId() because when a thread is terminated, this identifier may be reused.
GetThreadDumpResult	This class represents the result of the Get Thread Dump operation.
GlobalAndUnitaryOperation	This class implements the targeted operation and enables to define several targets with instance type and/or instance id.
GlobalOperation	This class implements the targeted operation and enables to define several targets with instance type.
IndicatorPersistentAccessException	Exception thrown when trying to access the value of a parameter that does not exist.
InstanceId	This Java class represents a classification for the instances in a deployed SAP CC Core Server system; This classification identifies a system instance by an instance type associated to a number that identifies the instances of the same type.
InstanceInfo	This Java interface represents the interface of the instance information; Consider the InstanceInfoImpl class.
InstanceInfoImpl	This class represents an instance information that includes the communication settings of a server instance of the connected SAP CC Core Server system; It contains the configuration of the different technical interfaces that are enabled.
InstanceMap	This Java class represents the current instance map of an SAP CC system; It is a named set of InstanceInfo describing all the instances working for the same SAP CC Core Server system.
InstanceProperty	This class represents an instance property that is the between a key instance property and its value.
InstanceStatus	This Java class represents an instance status that describes the running status (on, off, waiting) of a specific instance of the SAP CC system; It contains a list of instance properties.
InstanceType	This enumeration lists the predefined types of instances that form an SAP CC system (Core Server, BART Server); The type information may be used to identify a particular instance in an SAP CC system.
InvalidInstanceException	Exception thrown when an error occurs.
InvalidInstanceException.Reason	This enumeration lists the possible reasons for the invalid instance exception.
InvalidParameterValueException	Exception thrown when trying to set the value of a parameter to a value that is not valid for this parameter; The exception contains the current parameter value.
ListClientsOp	This operation allows retrieving the list of charging clients connected to the SAP CC system.
ListClientsResult	This class represents the response of a List Clients operation; It contains the list of charging clients connected to the SAP CC Core Server system.
MaintainCustomerManagementAreaListOp	FOR INTERNAL USE ONLY - This operation allows to maintain the list of customer management areas declared in the connected SAP CC system.
MaintainCustomerManagementAreaListResult	FOR INTERNAL USE ONLY - This class represents the result of the Maintain Customer Management Area List Operation; It contains the list of customer management areas configured in the connected SAP CC system.
MasterDispatcherOperation	This class implements the targeted operation and it enables to target the master dispatcher instance in the connected SAP CC Core Server system.
NoTargetDefinedException	Exception thrown when trying to access the value of a parameter that does not exist.
ParameterConcurrentAccessException	Exception thrown when trying to access the value of a parameter that does not exist.
ParameterOperation	This abstract Java class facilitates the management of operations dedicated to SAP CC system parameters; This class serves as a base Java class.
ParameterOperationResult	This abstract Java class facilitates the handling of the operation results relating to the management of system parameters in the connected SAP CC system;
PingOp	This operation allows you to check if the Administration Service of an instance in the SAP CC Core Server system is alive.
PingResult	This class represents the result of the Ping operation; It contains a status set to true if the distant instance of the SAP CC system is alive, false otherwise.
PurgeAllowancesOp	FOR INTERNAL USE ONLY - See the Admin+ user interface; This mass operation allows to trigger the Purge Allowances process on all the charging contracts (Concept: provider contracts) in customer master data of a service provider; It contains a date which is used as from date reference to remove allowances.
PurgeAllowancesResult	FOR INTERNAL USE ONLY - This class represents the result of the Purge Allowances operation; It contains an overall execution status (see PurgeAllowancesResult.PERFORMED_STATUS, #INCOMPLETE_STATUS, or #STOPPED_STATUS) and the total count of processed provider contracts.
PurgeFileMetadataOp	FOR INTERNAL USE ONLY - See the Admin+ user interface. This operation allows to delete sets of file metadata linked to a root data file whose purge reference date is lower than the specified reference date.
PurgeFileMetadataResult	FOR INTERNAL USE ONLY - See the Admin+ user interface. This class represents the result of the Purge File Metadata operation.
PurgeIdempotencyStorageOp	This operation allows you to purge the old idempotency records in the back-end database system.
PurgeIdempotencyStorageResult	This class represents the result of the Purge Idempotency Storage operation.
PurgeJobRecordOp	This operation is used to purge the Job Record records in the database.
PurgeJobRecordResult	This class represents the result of the Purge Job Record operation.
RefreshRatingInstancesOp	This operation is used to switch offer caches on all the rater and bulkloader instances (flip, flap mechanism).
RefreshRatingInstancesResult	This class represents the result of the Refresh Rater Instances operation.
RefreshSharedAllowanceCacheOp	This operation is used to refresh the shared allowance cache on all the rater instances.
RefreshSharedAllowanceCacheOp.RefreshSharedAllowanceCacheMode
RefreshSharedAllowanceCacheResult	This class represents the result of the Refresh Shared Allowance Cache operation.
RefreshTaxCacheOp	This operation is used to switch tax cache on all the rater and updater instances (flip, flap mechanism).
RefreshTaxCacheResult	This class represents the result of the Refresh Tax Cache operation.
RefreshTransServTypeListOp	This operation allows you to update Taxer transaction/service type list in the instances of the connected SAP CC system.
RefreshTransServTypeListResult	This class represents the result of the Refresh Rater Instance operation.
RefreshVatRulesCacheOp	This operation allows you to refresh the VAT rules cache on all the rater and updater instances in the connected SAP CC system.
RefreshVatRulesCacheResult	This class represents the result of the Refresh VAT Rules Cache operation.
ResetCachesOp	This operation allows you to reset the data caches of the connected SAP CC Core Server system; It can reset L2 cache, access cache, or both.
ResetCachesResult	This class represents the result of the Reset Caches operation.
ResetParameterValueOp	This operation allows you to reset an administration parameter to its default value.
ResetParameterValueResult	This class represents the result of the Reset Parameter Value operation; It is the parameter model which has been reset.
Role	This enumeration lists the predefined roles for the SAP CC users.
RoleModel	This Java class represents a role that can be assigned to the SAP CC users; It contains a set of authorizations to allow or not the execution of certain operations by the connected SAP CC system.
Scope	This enumeration lists the scopes (PERSISTENT or MEMORY) associated to the values of an SAP CC system parameter.
SearchUserSessionOp	This operation allows you to list the user sessions currently running on the server system. This operation can be used to find a particular user session and retrieve its identifier, so that it can be deleted using the Delete User Session operation.
SearchUserSessionResult	This class represents the result of Search User Session operation that contains the list of user sessions currently running in the connected SAP CC system.
SearchUserSessionResult.UserSessionModel	This Java class represents a user session.
ServerManagementOp	This abstract Java class serves as a base class for the server system management operations; Consider also the known subclasses that extend this Java class: ServerShutdownOp.
ServerManagementResult	This abstract Java class represents the result of the Server Management operation; Consider the known Java subclasses that extend this Java class: ServerShutdownResult.
ServerShutdownOp	This operation allows you to stop a specific instance in the connected SAP CC Core Server system.
ServerShutdownResult	This class represents the result of the Server Shutdown operation; It contains the acknowledge of the SAP CC system.
ServerStatus	This enumeration lists the possible statuses of an instance in an SAP CC system in the system landscape.
ServiceInfo	This Java class represents the service information.
ServiceInfo.Address	This Java class defines the URL of an SAP CC service.
ServiceInfo.ServiceAvailability	This Java class
ServiceInfo.ServiceAvailability.ServiceAvailabilityType	This enumeration lists all the types of service availability: MANDATORY, OPTIONAL, or FORBIDDEN.
ServiceInfo.ServiceInfoSecurity	This enumeration defines the security information: off, one way, or dual.
ServiceInfo.ServiceInfoType	This enumeration lists all the types of communication services.
SetMaintenanceModeOp	This operation allows to enable or disable the maintenance mode for the Core Server system.
SetMaintenanceModeResult	This result corresponds to the SetMaintenanceModeOp operation.
SetParameterValueOp	This operation allows you to set up an SAP CC system parameter to a specified value.
SetParameterValueResult	This class represents the result of the Set Parameter Value operation; This result is the parameter model whose value has been set.
SetStandbyStatusOp	This operation allows to set or unset the standby status for a set of Core Server instances.
SetStandbyStatusResult	This result corresponds to the SetStandbyStatusOp operation.
SQLConnectionAdminOp	This operation allows you to manually reconnect or disconnect an SQL connection of the targeted system instance(s).
SQLConnectionAdminOp.DatabaseScope	This enumeration lists the possible back-end database of SAP CC: Core Database, Session Database.
SQLConnectionAdminResult	This class represents the result of the SQL Connection Admin operation.
SQLConnectionsRefreshOp	This operation is used to manually refresh all SQL connections of the targeted system instance(s).
SQLConnectionsRefreshResult	This class represents the result of the SQL Connections Refresh operation.
StandbyException	Exception thrown when an error occurs during the execution of the SetStandbyStatusOp operation.
StandbyException.StandbyExceptionReason	This enumeration lists the possible reasons for StandbyException.
StandbyInstance	This model represents an instance identifier and the related standby status.
StartCacheWarmupOp	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.
StartCacheWarmupResult	This class represents the result of the Start Cache Warm-Up operation.
StartStopPlugin	This Java interface defines a listener plugin.
StatusModel	This Java class represents the status of an instance in the SAP CC system.
StopActivationOp	This operation allows you to stop a running activation process on subscriptions originally triggered by using the Activate All operation.
StopActivationResult	This class represents the result of the Stop Activation or of the Stop Charging Contract Activation operations.
StopChargingContractActivationOp	This operation allows you to stop a running activation process with charging contracts triggered with the Charging Contract Activate operation.
StopCleanupOp	This operation allows you to stop a running cleanup.
StopCleanupResult	This class represents the result of the Stop Cleanup operation.
StopPurgeAllowancesOp	FOR INTERNAL USE ONLY - See the Admin+ user interface; This operation stops a running purge allowances process with charging contracts triggered with the Purge Allowances operation.
StopPurgeAllowancesResult	FOR INTERNAL USE ONLY - This class represents the result of the Stop Purge Allowances operation; It contains an overall execution status and the total count of checked provider contracts.
SwitchDBFileDirectoriesOp	This operation allows releasing all the output data files resulting from the business processes and to trigger the bulk loading process.
SwitchDBFileDirectoriesResult	This class represents the result of the Switch DB File Directories operation.
System	This Java class represents the system instance in an SAP CC system.
SystemStatus	This Java class represents the system status that is a list of statuses for each instance in the connected SAP CC system.
TargetedOperation	Decorator to declare targets for an admin operation.
UnitaryOperation	This class implements the targeted operation and enables to define several targets with instance id.
UnknownParameterException	Exception thrown when trying to access the value of a system parameter that does not exist when using the Get Parameter Value operation.