org.lightningj.paywall.annotations

Annotation Type PaymentRequired

@Documented
 @Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface PaymentRequired

Main annotation used on a WebService of WebPage controller or similar endpoint to indicate that payment is required to allow access.

It contains a number of options:

• articleId, determines the type of order that should be generated, used by PaymentHandler to determine order amount depending on article an units. (Required if not a custom OrderRequestGenerator is used).
• units, The number of units for given article number, default is 1
• payPerRequest, if payment is valid for one request only. (Usually for WebService Request)
• orderRequestGenerator, possibility to specify a custom order request generator, instead of the default one using the articleId and units to request an order.
• requestPolicy, defining what in HTTP request that is considered relevant for determining a unique payment.
• customPolicy, if the redefined request policy types isn't applicable and a custom implementation is necessary.
• paymentOptions, extra options that might be needed by PaymentHandler to generate an Order (first type in a payment flow).

Created by Philip Vendil on 2018-09-07.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	articleId
java.lang.Class<? extends RequestPolicy>	customPolicy
java.lang.Class<? extends OrderRequestGenerator>	orderRequestGenerator
PaymentOption[]	paymentOptions
boolean	payPerRequest
RequestPolicyType	requestPolicy
int	units

Element Detail

articleId

public abstract java.lang.String articleId

Returns:

determines the type of order that should be generated, used by PaymentHandler to determine order amount depending on article an units. (Required if not a custom OrderRequestGenerator is used).

Default:

""

units

public abstract int units

Returns:

The number of units for given article number, default is 1

Default:

1

payPerRequest

public abstract boolean payPerRequest

Returns:

if payment is valid for one request only. (Usually for WebService Request)

Default:

false

orderRequestGenerator

public abstract java.lang.Class<? extends OrderRequestGenerator> orderRequestGenerator

Returns:

possibility to specify a custom order request generator, instead of the default one using the articleId and units to request an order.

See Also:

OrderRequestGenerator

Default:

org.lightningj.paywall.orderrequestgenerator.DefaultOrderRequestGenerator.class

requestPolicy

public abstract RequestPolicyType requestPolicy

Returns:

defining what in HTTP request that is considered relevant for determining a unique payment.

See Also:

RequestPolicyType

Default:

org.lightningj.paywall.requestpolicy.RequestPolicyType.WITH_BODY

customPolicy

public abstract java.lang.Class<? extends RequestPolicy> customPolicy

Returns:

custom class if none of the predefined request policy types isn't applicable and a custom implementation is necessary.

See Also:

RequestPolicy

Default:

org.lightningj.paywall.requestpolicy.NoCustomRequestPolicy.class

paymentOptions

public abstract PaymentOption[] paymentOptions

Returns:

extra options that might be needed by PaymentHandler to generate an Order (first type in a payment flow).

See Also:

PaymentOption

Default:

{}