com.highdeal.hci (SAP CC 5.0 Java APIs (Core Library))

Interface Summary
Interface	Description
ClientMessageListener	This `Java interface` defines a listener that is notified each time a client is notified of an operation stopped, progress, and completed; It extends the `MessageListener interface`.
CrossReferenceableOp	A `CrossReferenceableOp` is an extension of a `MessageOperation`.
CrossReferenceableResult	The root `Java interface` for marshallables that can provide a cross-reference.
IExportable<T extends XMLMarshallable>	This interface is used for object exportable in XMLMarshallable
IHCIOperation	This `Java interface` represents an HCI operation known by the SAP CC system.
ITagNameProvider	This `Java interface` defines a marshallable object that provides its XML tag name via the `getTagName() method`.
IXMLMarshallable	This `Java interface` defines the methods to marshal the attributes of an element and the child elements of an element.
MessageAuthentication	This `Java interface` represents the authentication data used for a given authentication scheme.
MessageContext	This `Java interface` defines the necessary `Java methods` to handle `HCI messages` sent via asynchronous communications; A message context is returned by the `MessageSender.asyncSend(com.highdeal.hci.MessageEnvelope, com.highdeal.hci.ClientMessageListener)` operation to cancel the message or retrieve results of the message when it is completelly processed by the connected SAP CC system.
MessageListener	This `Java interface` defines a communication listener in your client application; This listener is notified when an `operation` is completed, when the current operation notifies progress, and when a `message` (message envelope) is completed.
MessageOperation	This `Java interface` is the basis of all the `Java classes` that represent service operations available with the HTTP Communication Interface (HCI) technical interface provided by SAP Convergent Charging; Consider all the Java classes that implement this Java interface.
MessageSender	This `Java interface` is the parent interface for all the message senders that you can implement in your client applications depending on your business requirements; it defines the necessary methods for sending (`asynchronous`, `synchronous`, or `client-side timeout`) the HCI messages that include the operation requests for the connected SAP CC system.
MessageSender.IRedirectHandler	This `Java interface` enables to be aware of HTTP redirection events in your client application.
OperationResult	This `Java interface` is the root interface for all the operation results replied by the connected SAP CC Core Server system; Consider the `Java classes` that implement this interface: the results of the operation requests and the exceptions that can be thrown by the SAP CC system.
ReferenceHandler	This `Java interface` defines a reference handler that is called when a reference has been solved.
Type	Helper interface that contains a collection of constants to manage types.
XMLAttributes	This `Java interface` allows to access to the attributes of an XML tag.
XMLMapping	This `Java interface` defines the mapping between XML tags and Java classes; The `Java classes` returned through this mapping must have a default constructor.
XMLMarshallable	This `Java interface` serves as a base for objects that can be marshalled and unmarshalled; Consider the `Java subinterfaces` and the `Java classes` that implement this interface.
XMLMarshallableComparator.XMLMarshallableCleaner<T>
XMLOutputter	This `Java interface` provides the necessary `methods` to output XML documents in an event-based manner; Consider the `Java classes` that implement this interface.

Class Summary
Class	Description
AbstractParameterModel	This `Java class` represents a configurable parameter description.
AdditionalInfoModel	The `AdditionalInfoModel` represents an information used as search criteria to find `Data`.
AdminMessageSender
AuditModel	This `Java class` represents the description of an audit custom filter as seen by your client applications; This data model allows filtering a list of user operation execution recordings already stored by the SAP CC system.
AuthenticateUserOp	This operation allows you to check the login and password of an `SAP CC user` and to retrieve the `assigned roles` and granted `authorization objects` resulting from the merge of all the roles assigned to the user.
AuthenticateUserResult	This class represents the result of the `Authenticate User operation`; It contains the definition of the authenticated `SAP CC user` with granted `authorization`.
AuthenticateUserResult.FailedAuthenticationModel	Represents a failed authentication attempt, including a record date and a source address.
BooleanModel	This `Java class` is a `Boolean` container; It extends the `java.lang.Boolean` class by adding features to marshal this object type.
CreateAuditOp	This operation allows you to create a new `audit`.
CreateAuditResult	This class represents the result of the `Create Audit operation`; It contains the code and the reference of the `audit` that has been created.
CreateUserOp	This operation allows you to create an `SAP CC user` with the necessary `roles`.
CreateUserResult	This class represents the result of the `Create User operation`; It contains the login of the `new SAP CC user`.
CurrencyModel	This `Java class` represents a currency as a `Java Currency` container; This class extends the java.lang.Currency by adding features to marshal the objects.
DateModel	This `Java class` is a `Java Date` container; This class extends the java.lang.Date by adding features to marshal the objects.
DeleteAuditOp	This operation allows you to remove an `audit` in data stored in the connected SAP CC system.
DeleteAuditResult	The class represents the result of the `Delete Audit operation` and returns the reference and the code of the `removed audit`.
DeleteUserOp	This operation allows you to remove an `SAP CC user`; A user cannot delete itself and an `NotAuthorizedException` will be thrown by the system.
DeleteUserOperationFromAuditOp	This operation allows you to remove one or several `user's operations` extracted from `filters` of `audit` applied in a time period; If the audit has no filter, the connected SAP CC system deletes all the user's operations from this time period.
DeleteUserOperationFromAuditResult	The delete user operation result returns the reference and the code of the audit and the time period from which user's operations have been removed.
DeleteUserOperationFromFiltersOp	This operation allows you to remove one or several user's operations extracted from filters applied in a time period; If no filter all user's operations are removed from this time period.
DeleteUserOperationFromFiltersResult	The delete user operation from filters result returns the filters and the time period from which user's operation have been removed.
DeleteUserResult	The class represents the result of the `Delete User operation`; it contains the login of the `deleted SAP CC user`.
DescriptionModel	This class is a `description` container.
DisconnectUserOp	This operation allows you to close a user session that has been previously opened using the `Authenticate User operation`.
DisconnectUserResult	This result is sent in response to the `Disconnect User operation`; It contains the identifier of the SAP CC user session that has been deleted.
EmptyXMLNode	Create an empty xml node using the IXMLMashallable API.
EntityUnresolver	This entity resolver prevents the resolution of external/internal entities.
FileEnvelope	This class is used for save in and load from file a set of `XMLMarshallable` objects.
HCIClientOperation	This `Java class` represents all the `operations` that you can implement in your client application that communicates via the HCI technical interface.
HCIMapping	This class implements the mapping (for `HCI`) between Java classes and XML elements; The Java libraries of SAP CC convert the Java classes based on `MessageOperation` Java interface to `XML messages`.
HCIModelAdapter	Adapts HCI models to new interface `IXMLMarshallable`.
MessageBody	This `Java class` represents the body of a `message sent via HCI` sent by your client application to a connected SAP CC system; it is a set of `operations` or a set of `operation results`.
MessageEnvelope	This `Java class` represents the envelope of a message sent via the HTTP Communication Interface (HCI) technical interface; it contains a `header` and a `body` with multiple operation requests for the connected SAP CC system.
MessageHeader	This `Java class` represents the header of a `message sent via HCI` sent by your client application to a connected SAP CC Core Server system; It includes information about the `message originator` and specifies the processing mode (`MessageHeader.TRANSACTION_ALL`) of the operation requests that are included in the `sent message body`.
MessageOperationAdapter	Adapter for `HCI operations` to use new `XML marshalling`.
MessageOriginator	This `Java class` represents the originator of a `message` sent via the HCI technical interface to a connected SAP CC Core Server system.
MessageSenderFactory	This `abstract Java class` defines a factory API that enables your client applications (using the HCI technical interface) to create a `message sender object`; Consult the `subclasses` that extend this `Java class`.
ModifyAuditOp	This operation allows you to modify an `audit` stored in the data of the connected SAP CC system.
ModifyAuditResult	The modify audit result returns the reference and the code of the modified audit.
ModifyPasswordOp	This operation allows you to modify a user password. A `InvalidPasswordException` will be thrown by this operation if the advanced password management feature is enabled and if the password does not comply with the security requirements.
ModifyPasswordResult	This class represents the result of the `Modify Password operation`.
ModifyUserOp	This operation allows you to modify information related to an `SAP CC user` already created in the system.
ModifyUserResult	This class represents the result of the `Modify User operation`; It contains the login information of the `modified SAP CC user`.
NumberModel	This class is a `BigDecimal` container.
OperationResultAdapter	Adapter for `HCI operation result` to use new `XML marshalling`.
RecurringDate
ReferenceResolver	A reference resolver treats the reference to update the reference handlers that subscribed to a reference.
SearchAuditsOp	This operation allows you to search an `audit` from a specified code; If you specify a `null` code, then all the audits are retrieved.
SearchAuditsResult	This class represents the result of the `Search Audit operation`.
SearchUserOp	This operation allows you to search for a `SAP CC user` by specifying the login.
SearchUserOperationFromAuditsOp	This operation allows you to extract user's operations from user's operation filters of audit applied in a time period.
SearchUserOperationFromAuditsResult	This class represents the result of the `Search User Operation From Audit` operation.
SearchUserOperationFromFiltersOp	This operation allows extracting user's operations from filters applied in a time period; If no filter all user's operations are retrieved from this time period.
SearchUserOperationFromFiltersResult	This class represents the result of the `Search User Operation From Filters` operation.
SearchUserOperationOp	This operation allows you to retrieve `user operations` using a `specialized search filter`.
SearchUserOperationResult	This class represents the result of the `Search User Operation` `operation`; If the corresponding search operation request has been configured to return objects, this operation result contains the `user operations`.
SearchUserResult	This class represents the result of the `Search User operation`; It contains the `SAP CC users` that match the criteria specified in the corresponding search operation.
ServerFailureExceptionClientSideTranslator	This `Java class` is used in an internal way to translate non business exception comming from the connected SAP CC system into a common representation which is the `Server Failure Exception`.
SimpleMessageAuthentication	This class represents the authentication data used for the "simple" schema, that is a password.
StringModel	This `Java class` is a `Java String` container; It extends the `java.lang.String` class by adding features to marshal this object type.
UpdaterMessageSender
UserModel	This `Java class` represents a user of SAP Convergent Charging software; A user is any person (individual) or machine (service) allowed to work with SAP CC according to his `assigned roles` and resulting `authorizations`.
UserOperationFilterModel	This `Java class` represents the user operation filter as seen by your client application.
UserOperationModel	This `Java class` represents an audited user operation that has been processed and recorded by the SAP CC system; Your client application can consult the operation results by implement the handling of `audits` or by using the existing user interfaces to audit operations.
UserOperationSearchFilterModel	This class represents a `search filter` dedicated to the possibility to specify a set of `criteria` to retrieve `user operations` using the `Search User Operation` operation.
XMLAttributesImpl	Implementation of HCI XML attributes from a SAX 2 parser.
XMLMappingList	This `Java class` allows to merge different XML mapping objects into one.
XMLMarshallableComparator<T extends XMLMarshallable>
XMLNode	Helper class that can be used during parsing of spurious tags.
XMLOutputterWriter	Implementation of an XMLOutputter using a writer.
XMLUnmarshaller	This class supports the HCI infrastructure and should not be used directly in your code.
XMLUTF8OutputterWriter	Implementation of an XMLOutputter using a writer.
XMLUtils	This `Java class` provides a collection `Java methods` for XML utilities.

Enum Summary
Enum	Description
HCIClientOperation.HCIOperation	This `enumeration` lists all the HCI operations that are available; You can implement these service operations in your client application.
InvalidCreationErrorException.InvalidCreationCategory	This `enumeration` lists all the categories of errors that may occur during the creation of a master data in the connected SAP CC system: already exists, invalid, incompatible configuration, illegal state, or temporary illegal state.
InvalidDeletionErrorException.InvalidDeletionCategory	This `enumeration` lists all the categories of errors that may occur during the deletion of a master data.
InvalidDeletionException.ObjectTypeStillReferenced	This `enumeration` lists the types of an object that is still referenced in the SAP CC system.
InvalidMaintainErrorException.InvalidMaintainCategory	This `enumeration` lists all the categories of errors that may occur during the maintenance of a master data.
InvalidModificationErrorException.InvalidModificationCategory	This `enumeration` lists all the categories of errors that may occur during the modification of a master data.
MessageHeader.TransactionMode	This `enumeration` lists the transaction modes used by the SAP CC system to process the received operation messages and the service operations that are included in these `message envelopes`.
TableScope	Enumeration specifying the scope of a table. A charge plan status can be: `catalog`: only tables own by a catalog `agreement`: only tables attached to an agreement id `both`: all the tables
ValueType	This `enumeration` lists the basic types (string, date, and number) and defines the necessary `Java methods`.

Exception Summary
Exception	Description
AlreadyExistException	Generic exception thrown when there is an attempt to create an entity with a unique code (such as a product or a business relationship) that already exists.
AuthenticationFailedException	Exception thrown when an error occurs during the authentication of the `SAP CC user` that is the `message originator`.
BadConfigurationException	Exception thrown in your client application when a bad method argument or configuration settings are specified to a `message sender factory`.
BadMessageFormatException	Exception thrown when a `message` with a bad format is received by the SAP CC system.
CannotCancelException	Exception thrown when a message cannot be canceled.
CommunicationFailureException	Exception thrown when the HCI communication between your client application and the SAP CC Core Server system fails; get the `host information` (as a string) and the `numerical response code of the HTTP communication layer`.
DoesNotExistException	Generic exception thrown when there is an attempt to access something with a unique code (such as a product or a business relationship) that does not exist.
EntityUnresolver.ForbiddenEntityResolutionException	Exception thrown when an entity resolution is requested.
IgnorableTagException	Exception thrown when a tag can be safely ignored in a mapping.
IncompatibleOperationException	Generic exception thrown when the operation is invalid in the context.
InvalidCreationErrorException	Generic exception thrown when there was an error in the SAP CC system when attempting to create something that is not valid; The error type specifies the reason.
InvalidCreationException	Generic exception thrown when there is an attempt to create something that is not valid.
InvalidDeletionErrorException	Generic exception thrown when there is an attempt to delete something that is not valid; It specifies the exception category (does not exist, invalid, prerequisite missing, illegal state, or temporary illegal state), the direct cause of the exception, and the optional 'caused by' information that represent an exception stack.
InvalidDeletionException	Generic exception thrown by the SAP CC system when there is an attempt to delete something that cannot be deleted; The objects can have `different types` (master data, technical data, system configuration).
InvalidExportException	Generic exception thrown when there is an attempt to export something which is not valid.
InvalidImportException	Generic exception thrown when there is an attempt to import something that is not valid.
InvalidInitializationException	Exception thrown by the SAP CC system.
InvalidMaintainErrorException	Generic exception thrown when there is an attempt to maintain something which is not valid.
InvalidModificationErrorException	Generic exception thrown when there is an attempt to modify something which is not valid.
InvalidModificationException	Generic exception thrown when there is an attempt to modify something in an invalid way.
InvalidOperationErrorException	Generic exception thrown when a prerequisite of the master data is missing.
InvalidPasswordException	Exception thrown when an error occurs during the modification of the password of an SAP CC user.
NotAuthorizedException	Generic exception thrown when the `SAP CC user` is not allowed to request an operation for one of the following reasons: `Operation not allowed`: the SAP CC user is not allowed to call this operation according to his `role`. `NotAuthorizedException.CATALOG_RESTRICTION_VIOLATION`: the SAP user is associated to a `pricing catalog` and tried to perform an operation on an object from another catalog.
OperationCanceledException	Exception thrown when the operation has been canceled by the SAP CC user.
OperationFailureErrorException	This `abstract Java class` is the base representation of an `OperationFailureException` that includes an `error` (error code and arguments, comprehensive message, potential causes); Consider the `direct known subclasses`: `ServerErrorException`, `InvalidCreationErrorException`, and other error exceptions.
OperationFailureException	This `abstract Java class` represents the root exception for all the HCI operation exceptions; Consider the `known subclasses` detailed in this page and the `OperationFailureErrorException` marshallable exception to design your implementation and its error handling.
RetryableDatabaseException	Exception thrown when a SQL request returns an error like a deadlock or another that is retryable; The `SQL error message` is returned.
ServerErrorException	Exception thrown when a nonbusiness exception occurred in the connected SAP CC Core Server system; If such an exception occurs, it does not relate to a software bug in the SAP CC system (except for the "unsupportedFailure" reason that denotes a potential existing bug).
ServerFailureException	Exception thrown when a nonbusiness exception occurs in the connected SAP CC Core Server system; The initial operation request has failed but no change is stored in the back-end database system.
UnknownTagException	Exception thrown when an XML tag (XML element) has no mapping.
XMLIllegalArgumentException	This `Java class` supports the HCI infrastructure and should not be used directly in your implementation code.

Package com.highdeal.hci Description

This Java package provides the main Java classes and Java interfaces to implement the management of the communications between your client application and the connected SAP CC system via the HTTP Communication Interface (HCI) technical interface of SAP Convergent Charging; With this package, you can develop a client application able to send multiple operation requests and handle the results and exceptions.

Technical Interface	HCI (HTTP Communication Interface)
Communication Protocol	XML over HTTP (or HTTPS)
Communication Mode	Asynchronous, synchronous
Public Endpoints	Dispatcher instances of the SAP CC system (Each dispatcher instance has a communication port relating to the HTTP communications)
API Technology	[x] Java [ ] SOAP [x] Proprietary XML
SAP CC Java Library	`core-client.jar`
Security	Yes (see the SAP CC Security Guide)

Technical Interface: HTTP Communication Interface (HCI)

Communication Infrastructure

The HTTP Communication Interface (HCI) technical interface defines a communication infrastructure to exchange messages in envelopes between your client application and the connected SAP CC system.

Business Services

The HCI technical interface provides the following business services for configuring master data and customer master data.

Business Service	Master Data Configuration	Customer Master Data Configuration
Description	Catalog management	Provisioning
Services	Pricing Catalog Management in SAP CC Commercial Product Catalog Management in SAP CC	Business Partner and Agreement Management Order Capture and Contract Management Technical Data Management
Environment	Prepaid and postpaid	Prepaid and postpaid

Recommendation

Refer to the SAP CC Application Help for more information about the catalog management and about the customer data provisioning.

Technical Services

The HCI technical interface provides some technical services for administering the SAP CC systems. Consider the package com.highdeal.admin.hci that delivers these technical services and implement the operations depending on your business requirements.

APIs for the HTTP Communication Interface

To implement some business services available in the HCI technical interface of SAP CC, you can use the following Java packages:

Features

The HCI technical interface provides important features that you can implement in your SAP system landscape.

Note

Consult the SAP CC Application Help for more information about high availability, high volume data, and performances. It details the functions and mechanisms available in SAP Convergent Charging.

Security

The HCI technical interface provides secured communications via the HTTPS channel. Consult the SAP CC Security Guide.

Communications

XML over HTTP (or HTTPS)
Asynchronous, Synchronous
Public Endpoints: Dispatcher instances of the SAP CC system

Similar Information

Consider the following technical interfaces of SAP Convergent Charging:

Technical Interface	Specifications
Message TCP	In this SAP product documentation
Web Services	SOAP API Reference