Managing Gateway Clients

This section contains information that SDX owners and their business partners need to manage gateway clients and their interactions with the gateway.

Error Codes That Subscriber Manager Returns

When Subscriber Manager receives a SOAP request it cannot handle, it returns an error code to the gateway client. Administrators of the gateway client can use this information to fix a problem with the client or to notify the gateway administrator of a problem with Subscriber Manager. Subscriber Manager returns error codes as strings to the gateway client. See Table 12.

 Table 12:  Error Codes for Subscriber Manager 

 Error Code
 Meaning
 Action

 SubscriberMgmt.SUBSMGMT_API_BAD_ARGUMENT

 Gateway client passed an invalid argument. 

 Check that all arguments are correct.


 SubscriberMgmt.SUBSMGMT_API_FORBIDDEN

 Requested operation is forbidden. For example, a client requested to create a new subscriber whose unique ID is already used by another subscriber. 

 Check that the values are correct. If they are, contact the gateway administrator.


 SubscriberMgmt.SUBSMGMT_API_INVALID_DATA

 Gateway client passed an invalid value for an LDAP attribute. For example, the gateway client provided an incorrect string for a subscriber's IP address. 

 Check that attribute values are correct.


 SubscriberMgmt.SUBSMGMT_API_INVALID_DN

 Requested ID, such as subscriber ID or service ID, is invalid.

 Check that the values are correct. If they are, contact the gateway administrator.


 SubscriberMgmt.SUBSMGMT_API_LDAP_UNAVAILABLE

 LDAP server is not available. 

 Contact the gateway administrator.


 SubscriberMgmt.SUBSMGMT_API_LOCKED

 Requested LDAP object is currently locked and cannot perform the requested operation. 

 Request the LDAP object later.


 SubscriberMgmt.SUBSMGMT_API_TRANSPORT_FAILURE

 OSMW is not available.

 Contact the gateway administrator.


 SubscriberMgmt.SUBSMGMT_API_BAD_TARGET

 OSMW could not start a transaction for a given target.

 Contact the gateway administrator.


 SubscirberMgmt.SUBSMGMT_API_NOT_FOUND

 Requested transactionID is not found in transaction history.

 Contact the gateway administrator.



 

Results from OSMW Actions

Although the business partner does not know whether requests involve OSMW actions, Subscriber Manager does return the results of OSMW operations to the gateway client. Each result contains the following information:

• Boolean completion indicator (operation completed or not)
• Boolean success indicator (request successful or not)
• Either a transactionID value (OSMW started action) or an errorMsg value

Table 13 shows the results that Subscriber Manager can return to the gateway client.

 Table 13:  Results That Subscriber Manager Returns to Gateway Client 

 Completion Indicator
 Success Indicator
 Item Returned
 Meaning

 False

 True

 transactionID

 OSMW action is executing the transaction.


 False

 False

 errorMsg

 Request failed.


 True

 False

 errorMsg

 Request failed and the OSMW action is not being executed, or subscriber manager is not configured to use the OSMW.


 True

 True

 Nothing

 Request is successful and completed, and subscriber manager is not configured to use the OSMW.



 

Error Codes for Trace Requests

When a gateway client submits a trace request, Subscriber Manager returns an error code of the type int error, and a string that describes the error code. Table 14 lists the error codes and their meanings.

 Table 14:  Error Codes for Trace Requests 

 Error Code
 Meaning

 TraceResult.TRACE_RESULT_NO_ERROR

 Trace was successful.


 TraceResult.TRACE_RESULT_NO_SUCH_DATA

 Given transactionID is not found in histories.


 TraceResult.TRACE_RESULT_NO_SUCH_OBJ

 Subscriber or subscription is not found in the trace history.


 TraceResult.TRACE_RESULT_ABORT

 Trace operation cancelled because of the reason shown in errorMsg