|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ibm.ws.webservices.engine.client.Stub
com.ibm.soa.parlayx21.payment.ReserveVolumeChargingBindingStub
public class ReserveVolumeChargingBindingStub
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
com.ibm.ws.webservices.engine.client.Stub.Invoke |
Field Summary |
---|
Fields inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
cachedEndpoint, cachedhttpProxyHost, cachedhttpProxyPassword, cachedhttpProxyPort, cachedhttpProxyUser, cachedhttpRedirectEnabled, cachedhttpsProxyHost, cachedhttpsProxyPassword, cachedhttpsProxyPort, cachedhttpsProxyUser, cachedPassword, cachedPortName, cachedProperties, cachedRequestSoapHeaders, cachedRequestTransportHeaders, cachedResponseSoapHeaders, cachedResponseSoapHeaderTemplates, cachedResponseTransportHeaders, cachedResponseTransportHeadersTemplate, cachedSessionContext, cachedsslCfgName, cachedTimeout, cachedUsername, cachedWriteTimeout, connection, engine, maintainSession, maintainSessionSet, messageContexts, service |
Fields inherited from interface javax.xml.rpc.Stub |
---|
ENDPOINT_ADDRESS_PROPERTY, PASSWORD_PROPERTY, SESSION_MAINTAIN_PROPERTY, USERNAME_PROPERTY |
Constructor Summary | |
---|---|
ReserveVolumeChargingBindingStub(java.net.URL endpointURL,
javax.xml.rpc.Service service)
|
Method Summary | |
---|---|
void |
chargeReservation(java.lang.String reservationIdentifier,
long volume,
java.lang.String billingText,
java.lang.String referenceCode)
This operation results in charging to a volume reservation indicated by the reservation id. |
ChargingInformation |
getAmount(java.net.URI endUserIdentifier,
long volume,
Property[] parameters)
This operation returns the amount resulting from converting the given volume. |
void |
releaseReservation(java.lang.String reservationIdentifier)
This operation returns the funds left in a volume reservation indicated by reservation id to the account from which this reservation was made. |
void |
reserveAdditionalVolume(java.lang.String reservationIdentifier,
long volume,
java.lang.String billingText)
This operation adds/subtracts a volume to/from an existing volume reservation indicated by the reservation id. |
java.lang.String |
reserveVolume(java.net.URI endUserIdentifier,
long volume,
java.lang.String billingText,
Property[] parameters)
This operation reserves a volume for an account indicated by the end user identifier. |
Methods inherited from class com.ibm.ws.webservices.engine.client.Stub |
---|
_getProperty, _getPropertyNames, _setProperty, convert, getPassword, getPortName, getTimeout, getTypeMapping, getUsername, primeMessageContext, setMaintainSession, setPassword, setPortName, setPortName, setTimeout, setUsername, setWriteTimeout, validateSoapHeadersHashMap, validateTransportPropertiesHashMap |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public ReserveVolumeChargingBindingStub(java.net.URL endpointURL, javax.xml.rpc.Service service) throws com.ibm.ws.webservices.engine.WebServicesFault
com.ibm.ws.webservices.engine.WebServicesFault
Method Detail |
---|
public ChargingInformation getAmount(java.net.URI endUserIdentifier, long volume, Property[] parameters) throws java.rmi.RemoteException, PolicyException, ServiceException
ReserveVolumeCharging
This operation returns the amount resulting from converting the given volume. The end user identifier is given to indicate the subscriber for whom this calculation must be made. The message returns a currency amount if successful.
The following properties may be provided:
* unit, specifying the unit used for measuring volume (for example, bytes);
* contract, number of a contract that may govern the use;
* service, name of the service to be used (for example, SendMessageService);
* operation, name of the operation to be used (for example, sendMessage).
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
getAmount
in interface ReserveVolumeCharging
endUserIdentifier
- xsd:anyURI
The end user's account to be chargedvolume
- xsd:long
The volume to be convertedparameters
- Property [0..unbounded]
Parameters to use to perform rating ('unit', 'contract', 'service', 'operation')
The conversion process results in the return of a ChargingInformation structure, where the description, amount and currency elements must be non-null.
java.rmi.RemoteException
PolicyException
ServiceException
public java.lang.String reserveVolume(java.net.URI endUserIdentifier, long volume, java.lang.String billingText, Property[] parameters) throws java.rmi.RemoteException, PolicyException, ServiceException
ReserveVolumeCharging
This operation reserves a volume for an account indicated by the end user identifier. Note that reservations do not last forever; it is assumed the default reservation enforcement time is negotiated off-line. If the reservation times out, the remaining volume will be returned to the account from which this reservation was made. However, the remaining volume should preferably be returned explicitly to the account using the releaseReservation operation. The billing text field is used for textual information to appear on the bill. Subsequent textual information provided during this charging session will be appended to this textual information; one charging session to a reservation will result in only one entry on the bill. In case of success, a reservation identifier is returned for future reference; e.g. subsequent charging against the existing reservation using the chargeReservation operation.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
reserveVolume
in interface ReserveVolumeCharging
endUserIdentifier
- xsd:anyURI
The end user's account subject to the reservationvolume
- xsd:long
The volume of the reservationbillingText
- xsd:string
Textual information to appear on the billparameters
- Property [0..unbounded]
Parameters to use to perform rating (“unit”, “contract”, “service”, “operation”). There is a maximum of one instance of each parameter type. Example, for the request “reserve 5 minutes of the gold video service”, the volume part value is 5 and the parameters part has the following properties:
* “unit”=minutes
* “contract”=gold
* “service”=video
java.rmi.RemoteException
PolicyException
ServiceException
public void reserveAdditionalVolume(java.lang.String reservationIdentifier, long volume, java.lang.String billingText) throws java.rmi.RemoteException, PolicyException, ServiceException
ReserveVolumeCharging
This operation adds/subtracts a volume to/from an existing volume reservation indicated by the reservation id. Note that reservations do not last forever; it is assumed the default reservation enforcement time is negotiated off-line. Invoking this message will extend the reservation enforcement time for another off-line-negotiated period. The billing text field is used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveVolume operation; one charging session to a reservation will result in only one entry on the bill. A reserved credit can be returned to the account through the releaseReservation operation.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
reserveAdditionalVolume
in interface ReserveVolumeCharging
reservationIdentifier
- xsd:string
An identifier for the reservation to be amendedvolume
- xsd:long
The volume to be added to (or subtracted from) the reservation. [Note the associated rating parameters are the same as those defined in the parameters part of the original reserveVolumeRequest message.]billingText
- xsd:string
Textual information to appear on the bill
java.rmi.RemoteException
PolicyException
ServiceException
public void chargeReservation(java.lang.String reservationIdentifier, long volume, java.lang.String billingText, java.lang.String referenceCode) throws java.rmi.RemoteException, PolicyException, ServiceException
ReserveVolumeCharging
This operation results in charging to a volume reservation indicated by the reservation id. Reservations, identified by reservation id., are established through invoking the reserveVolume operation. Optionally, the billing text field can be used for appending textual information to appear on the bill. The textual information is appended to the initial textual information given by the reserveVolume operation; one charging session to a reservation will result in only one entry on the bill. The reference code is used to uniquely identify the request; it is the application's responsibility to provide a unique reference code within the scope of the application.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
* SVC0270 - Charge failed.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
chargeReservation
in interface ReserveVolumeCharging
reservationIdentifier
- xsd:string
An identifier for the reservation to be chargedvolume
- xsd:long
The volume to be charged. [Note the associated rating parameters are the same as those defined in the parameters part of the original reserveVolumeRequest message.][JR2]billingText
- xsd:string
Textual information to appear on the bill (optional)referenceCode
- xsd:string
Textual information to uniquely identify the request, for example, in case of disputes
java.rmi.RemoteException
PolicyException
ServiceException
public void releaseReservation(java.lang.String reservationIdentifier) throws java.rmi.RemoteException, PolicyException, ServiceException
ReserveVolumeCharging
This operation returns the funds left in a volume reservation indicated by reservation id to the account from which this reservation was made. Reservations, identified by reservation id., are established through invoking the reserveVolume operation.
ServiceException from ES 202 391-1 [2]:
* SVC0001 - Service error.
* SVC0002 - Invalid input value.
PolicyException from ES 202 391-1 [2]:
* POL0001 - Policy error.
releaseReservation
in interface ReserveVolumeCharging
reservationIdentifier
- xsd:string
An identifier for the reservation to be released
java.rmi.RemoteException
PolicyException
ServiceException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |