Pingback (Paymentwall java library 1.0 API)

java.lang.Object
- com.paymentwall.java.Base
- - com.paymentwall.java.Pingback

```
public class Pingback
extends Base
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`ipAddress` IP address, usually _SERVER["REMOTE_ADDR"]
`protected java.util.LinkedHashMap<java.lang.String,java.util.ArrayList<java.lang.String>>`	`parameters` Pingback parameters, usually received from parsing _GET
`int`	`PINGBACK_TYPE_GOODWILL`
`int`	`PINGBACK_TYPE_NEGATIVE`
`int`	`PINGBACK_TYPE_REGULAR` Pingback types
`int`	`PINGBACK_TYPE_RISK_REVIEWED_ACCEPTED`
`int`	`PINGBACK_TYPE_RISK_REVIEWED_DECLINED`
`int`	`PINGBACK_TYPE_RISK_UNDER_REVIEW`
`int`	`PINGBACK_TYPE_SUBSCRIPTION_CANCELLATION`
`int`	`PINGBACK_TYPE_SUBSCRIPTION_EXPIRED`
`int`	`PINGBACK_TYPE_SUBSCRIPTION_PAYMENT_FAILED`

Fields inherited from class com.paymentwall.java.Base
API_CART, API_GOODS, API_VC, CHARGE_URL, CONTROLLER_PAYMENT_CART, CONTROLLER_PAYMENT_DIGITAL_GOODS, CONTROLLER_PAYMENT_VIRTUAL_CURRENCY, DEFAULT_SIGNATURE_VERSION, errors, SIGNATURE_VERSION_1, SIGNATURE_VERSION_2, SIGNATURE_VERSION_3, SUBS_URL

Constructor Summary

Constructors
Constructor and Description

Pingback(java.util.Map<java.lang.String,java.lang.String[]> parameters_, java.lang.String ipAddress_)

Constructors
Constructor and Description
`Pingback(java.util.Map<java.lang.String,java.lang.String[]> parameters_, java.lang.String ipAddress_)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected java.lang.String`	`calculateSignature(java.util.LinkedHashMap<java.lang.String,java.util.ArrayList<java.lang.String>> params, java.lang.String secret, int version)` Build signature for the pingback received
`java.util.ArrayList<java.lang.String>`	`getParameter(java.lang.String key)` Get pingback parameter
`java.lang.String`	`getPingbackUniqueId()` Returns unique identifier of the pingback that can be used for checking if the same pingback was already processed by your servers.
`Product`	`getProduct()`
`java.lang.String`	`getProductId()` Get product id
`int`	`getProductPeriodLength()`
`java.lang.String`	`getProductPeriodType()`
`java.util.ArrayList<Product>`	`getProducts()`
`java.lang.String`	`getReferenceId()` Get pingback parameter "ref"
`java.lang.String`	`getType()` Get pingback parameter "type"
`java.lang.String`	`getTypeVerbal()` Get verbal explanation of the informational pingback
`java.lang.String`	`getUserId()` Get pingback parameter "uid"
`double`	`getVirtualCurrencyAmount()` Get pingback parameter "currency"
`boolean`	`isCancelable()` Check whether product is cancelable
`boolean`	`isDeliverable()` Check whether product is deliverable
`boolean`	`isIpAddressValid()`
`boolean`	`isParametersValid()`
`boolean`	`isSignatureValid()`
`boolean`	`isUnderReview()` Check whether product is under review
`boolean`	`validate()`
`boolean`	`validate(boolean skipIpWhitelistCheck)` Check whether pingback is valid

Methods inherited from class com.paymentwall.java.Base
appendToErrors, getApiType, getAppKey, getErrors, getErrorSummary, getProApiKey, getSecretKey, parseQuery, round, setApiType, setAppKey, setProApiKey, setSecretKey

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PINGBACK_TYPE_REGULAR
```
public final int PINGBACK_TYPE_REGULAR
```
    Pingback types
    
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_GOODWILL
```
public final int PINGBACK_TYPE_GOODWILL
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_NEGATIVE
```
public final int PINGBACK_TYPE_NEGATIVE
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_RISK_UNDER_REVIEW
```
public final int PINGBACK_TYPE_RISK_UNDER_REVIEW
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_RISK_REVIEWED_ACCEPTED
```
public final int PINGBACK_TYPE_RISK_REVIEWED_ACCEPTED
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_RISK_REVIEWED_DECLINED
```
public final int PINGBACK_TYPE_RISK_REVIEWED_DECLINED
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_SUBSCRIPTION_CANCELLATION
```
public final int PINGBACK_TYPE_SUBSCRIPTION_CANCELLATION
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_SUBSCRIPTION_EXPIRED
```
public final int PINGBACK_TYPE_SUBSCRIPTION_EXPIRED
```
    See Also:
    
    Constant Field Values
  - PINGBACK_TYPE_SUBSCRIPTION_PAYMENT_FAILED
```
public final int PINGBACK_TYPE_SUBSCRIPTION_PAYMENT_FAILED
```
    See Also:
    
    Constant Field Values
  - parameters
```
protected java.util.LinkedHashMap<java.lang.String,java.util.ArrayList<java.lang.String>> parameters
```
    Pingback parameters, usually received from parsing _GET
  - ipAddress
```
protected java.lang.String ipAddress
```
    IP address, usually _SERVER["REMOTE_ADDR"]
- Constructor Detail
  - Pingback
```
public Pingback(java.util.Map<java.lang.String,java.lang.String[]> parameters_,
                java.lang.String ipAddress_)
```
    Parameters:
    
    parameters_ - array of parameters received by pingback processing script, e.g. _GET
    
    ipAddress_ - IP address from where the pingback request originates, e.g. "127.0.0.1"
- Method Detail
  - validate
```
public boolean validate(boolean skipIpWhitelistCheck)
                 throws java.io.UnsupportedEncodingException,
                        java.security.NoSuchAlgorithmException
```
    Check whether pingback is valid
    
    Parameters:
    
    skipIpWhitelistCheck - if IP whitelist check should be skipped, e.g. if you have a load-balancer changing the IP
    
    Returns:
    
    bool
    
    Throws:
    
    java.io.UnsupportedEncodingException - md5 and sha256 calculation Digest
    
    java.security.NoSuchAlgorithmException - md5 and sha256 calculation Digest
  - validate
```
public boolean validate()
                 throws java.io.UnsupportedEncodingException,
                        java.security.NoSuchAlgorithmException
```
    Throws:
    
    java.io.UnsupportedEncodingException
    
    java.security.NoSuchAlgorithmException
  - isSignatureValid
```
public boolean isSignatureValid()
                         throws java.io.UnsupportedEncodingException,
                                java.security.NoSuchAlgorithmException
```
    Returns:
    
    bool
    
    Throws:
    
    java.io.UnsupportedEncodingException - md5 and sha256 calculation Digest
    
    java.security.NoSuchAlgorithmException - md5 and sha256 calculation Digest
  - isIpAddressValid
```
public boolean isIpAddressValid()
```
    Returns:
    
    bool
  - isParametersValid
```
public boolean isParametersValid()
```
    Returns:
    
    bool
  - getParameter
```
public java.util.ArrayList<java.lang.String> getParameter(java.lang.String key)
```
    Get pingback parameter
    
    Parameters:
    
    key - links to element in params hashmap by key
    
    Returns:
    
    string
  - getType
```
public java.lang.String getType()
```
    Get pingback parameter "type"
    
    Returns:
    
    int
  - getTypeVerbal
```
public java.lang.String getTypeVerbal()
```
    Get verbal explanation of the informational pingback
    
    Returns:
    
    string
  - getUserId
```
public java.lang.String getUserId()
```
    Get pingback parameter "uid"
    
    Returns:
    
    string
  - getVirtualCurrencyAmount
```
public double getVirtualCurrencyAmount()
```
    Get pingback parameter "currency"
    
    Returns:
    
    string
  - getProductId
```
public java.lang.String getProductId()
```
    Get product id
    
    Returns:
    
    string
  - getProductPeriodLength
```
public int getProductPeriodLength()
```
    Returns:
    
    int
  - getProductPeriodType
```
public java.lang.String getProductPeriodType()
```
    Returns:
    
    string
  - getProduct
```
public Product getProduct()
```
    Returns:
    
    Paymentwall_Product
  - getProducts
```
public java.util.ArrayList<Product> getProducts()
```
    Returns:
    
    array Paymentwall_Product
  - getReferenceId
```
public java.lang.String getReferenceId()
```
    Get pingback parameter "ref"
    
    Returns:
    
    string
  - getPingbackUniqueId
```
public java.lang.String getPingbackUniqueId()
```
    Returns unique identifier of the pingback that can be used for checking if the same pingback was already processed by your servers. Two pingbacks with the same unique ID should not be processed more than once
    
    Returns:
    
    string
  - isDeliverable
```
public boolean isDeliverable()
```
    Check whether product is deliverable
    
    Returns:
    
    bool
  - isCancelable
```
public boolean isCancelable()
```
    Check whether product is cancelable
    
    Returns:
    
    bool
  - isUnderReview
```
public boolean isUnderReview()
```
    Check whether product is under review
    
    Returns:
    
    bool
  - calculateSignature
```
protected java.lang.String calculateSignature(java.util.LinkedHashMap<java.lang.String,java.util.ArrayList<java.lang.String>> params,
                                              java.lang.String secret,
                                              int version)
```
    Build signature for the pingback received
    
    Parameters:
    
    params - represents parameters that are used for signature calculation
    
    secret - Paymentwall Secret Key
    
    version - Paymentwall Signature Version
    
    Returns:
    
    string

Class Pingback

Field Summary

Fields inherited from class com.paymentwall.java.Base

Constructor Summary

Method Summary

Methods inherited from class com.paymentwall.java.Base

Methods inherited from class java.lang.Object

Field Detail

PINGBACK_TYPE_REGULAR

PINGBACK_TYPE_GOODWILL

PINGBACK_TYPE_NEGATIVE

PINGBACK_TYPE_RISK_UNDER_REVIEW

PINGBACK_TYPE_RISK_REVIEWED_ACCEPTED

PINGBACK_TYPE_RISK_REVIEWED_DECLINED

PINGBACK_TYPE_SUBSCRIPTION_CANCELLATION

PINGBACK_TYPE_SUBSCRIPTION_EXPIRED

PINGBACK_TYPE_SUBSCRIPTION_PAYMENT_FAILED

parameters

ipAddress

Constructor Detail

Pingback

Method Detail

validate

validate

isSignatureValid

isIpAddressValid

isParametersValid

getParameter

getType

getTypeVerbal

getUserId

getVirtualCurrencyAmount

getProductId

getProductPeriodLength

getProductPeriodType

getProduct

getProducts

getReferenceId

getPingbackUniqueId

isDeliverable

isCancelable

isUnderReview

calculateSignature