org.cyclos.impl.utils

Interface LinkGeneratorHandler

public interface LinkGeneratorHandler

Generates links for various URLs in Cyclos

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ATTR_ENTITY_ID Script attribute: the entity id which relates to the link
static java.lang.String	ATTR_ENTITY_ID_PARAM Script attribute: the parameter name to use for the related entity id
static java.lang.String	ATTR_EXTERNAL_REDIRECT_EXECUTION Script attribute: the external redirect execution for custom operations
static java.lang.String	ATTR_LOCATION Script attribute: the link related location
static java.lang.String	ATTR_MOBILE_URL_FILE_PART Script attribute: the link related mobile url file part
static java.lang.String	ATTR_PAYMENT_AMOUNT Script attribute: the easy invoice amount
static java.lang.String	ATTR_PAYMENT_CURRENCY Script attribute: the easy invoice payment currency
static java.lang.String	ATTR_PAYMENT_CUSTOM_VALUES Script attribute: the easy invoice payment custom field values
static java.lang.String	ATTR_PAYMENT_DESCRIPTION Script attribute: the easy invoice payment description
static java.lang.String	ATTR_PAYMENT_TO Script attribute: the easy invoice payee
static java.lang.String	ATTR_PAYMENT_TYPE Script attribute: the easy invoice payment type
static java.lang.String	ATTR_TICKET Script attribute: the ticket
static java.lang.String	ATTR_TYPE Script attribute: the link type to be generated
static java.lang.String	ATTR_URL_FILE_PART Script attribute: the link related url file part
static java.lang.String	ATTR_USER Script attribute: the link related user
static java.lang.String	ATTR_VALIDATION_KEY Script attribute: the validation key

Method Summary

Modifier and Type	Method and Description
java.lang.String	customOperationExternalRedirect(ExternalRedirectExecution ere) Generates a link for an external redirect execution.
java.lang.String	easyInvoice(LocateUserResult payee, java.math.BigDecimal amount, java.lang.String description, Currency currency, PaymentTransferType paymentType, java.util.Map<TransactionCustomField,java.lang.String> customValues) Generates a link for an easy invoice.
java.lang.String	emailChange(java.lang.String key, BasicUser user) Generates a link for the validating an e-mail change for the given user.
java.lang.String	forgotPassword(java.lang.String key, BasicUser user) Generates a link for the forgot password request for the given user.
java.lang.String	location(Location location, BasicUser user) Generates a dynamic ("tagged") link for a given Location without using any id parameter, also the link will be created taking the user's network.
java.lang.String	location(Location location, java.lang.Long entityId, BasicUser user) Generates a link for a given Location and entity adding ID parameter in the URL with the entityId value, also the link will be created taking the user's network.
java.lang.String	location(Location location, java.lang.String idParamName, java.lang.Long entityId, BasicUser user) Generates a link for a given Location and entity adding the given parameter in the URL with the entityId value, also the link will be created taking the user's network.
java.lang.String	login(ConfigurationAccessor configuration) Generates a link to the application login page
java.lang.String	mobile(java.lang.String urlFilePart) Generates a link to be opened by the Mobile Application for the given Url file part. E.g cyclos://forgotPassword?key=ZBCXYZ
java.lang.String	mobileRedirect(java.lang.String urlPart, BasicUser user) Generates a link which will redirect the user to the mobile application under the given URL part.
java.lang.String	registrationValidation(java.lang.String key, BasicUser user) Generates a link for the registration validation of the given user.
java.lang.String	ticket(Ticket ticket) Generates a link for paying the given ticket.

Field Detail

ATTR_TYPE

static final java.lang.String ATTR_TYPE

Script attribute: the link type to be generated

See Also:

Constant Field Values

ATTR_VALIDATION_KEY

static final java.lang.String ATTR_VALIDATION_KEY

Script attribute: the validation key

See Also:

Constant Field Values

ATTR_USER

static final java.lang.String ATTR_USER

Script attribute: the link related user

See Also:

Constant Field Values

ATTR_LOCATION

static final java.lang.String ATTR_LOCATION

Script attribute: the link related location

See Also:

Constant Field Values

ATTR_ENTITY_ID

static final java.lang.String ATTR_ENTITY_ID

Script attribute: the entity id which relates to the link

See Also:

Constant Field Values

ATTR_ENTITY_ID_PARAM

static final java.lang.String ATTR_ENTITY_ID_PARAM

Script attribute: the parameter name to use for the related entity id

See Also:

Constant Field Values

ATTR_URL_FILE_PART

static final java.lang.String ATTR_URL_FILE_PART

Script attribute: the link related url file part

See Also:

Constant Field Values

ATTR_MOBILE_URL_FILE_PART

static final java.lang.String ATTR_MOBILE_URL_FILE_PART

Script attribute: the link related mobile url file part

See Also:

Constant Field Values

ATTR_EXTERNAL_REDIRECT_EXECUTION

static final java.lang.String ATTR_EXTERNAL_REDIRECT_EXECUTION

Script attribute: the external redirect execution for custom operations

See Also:

Constant Field Values

ATTR_TICKET

static final java.lang.String ATTR_TICKET

Script attribute: the ticket

See Also:

Constant Field Values

ATTR_PAYMENT_TO

static final java.lang.String ATTR_PAYMENT_TO

Script attribute: the easy invoice payee

See Also:

Constant Field Values

ATTR_PAYMENT_AMOUNT

static final java.lang.String ATTR_PAYMENT_AMOUNT

Script attribute: the easy invoice amount

See Also:

Constant Field Values

ATTR_PAYMENT_TYPE

static final java.lang.String ATTR_PAYMENT_TYPE

Script attribute: the easy invoice payment type

See Also:

Constant Field Values

ATTR_PAYMENT_CURRENCY

static final java.lang.String ATTR_PAYMENT_CURRENCY

Script attribute: the easy invoice payment currency

See Also:

Constant Field Values

ATTR_PAYMENT_DESCRIPTION

static final java.lang.String ATTR_PAYMENT_DESCRIPTION

Script attribute: the easy invoice payment description

See Also:

Constant Field Values

ATTR_PAYMENT_CUSTOM_VALUES

static final java.lang.String ATTR_PAYMENT_CUSTOM_VALUES

Script attribute: the easy invoice payment custom field values

See Also:

Constant Field Values

Method Detail

customOperationExternalRedirect

java.lang.String customOperationExternalRedirect(ExternalRedirectExecution ere)

Generates a link for an external redirect execution. The default URL is {root}/external-redirect-callback/{maskId(ere.getId()}/{ere.getVerificationToken()}

easyInvoice

java.lang.String easyInvoice(LocateUserResult payee,
                             java.math.BigDecimal amount,
                             java.lang.String description,
                             Currency currency,
                             PaymentTransferType paymentType,
                             java.util.Map<TransactionCustomField,java.lang.String> customValues)

Generates a link for an easy invoice. The default URL is {root}/pay?to={payee.principal}&amount={amount}&description={description}¤cy={maskId(currency.id)}&type={maskId(type.id)}[&{customValues.key.internalName}={customValues.value}]

emailChange

java.lang.String emailChange(java.lang.String key,
                             BasicUser user)

Generates a link for the validating an e-mail change for the given user. The default URL is {root}/content/users/validateEmailChange?key={key}

forgotPassword

java.lang.String forgotPassword(java.lang.String key,
                                BasicUser user)

Generates a link for the forgot password request for the given user. The default URL is {root}#access.passwords.forgot!key={key}

location

java.lang.String location(Location location,
                          BasicUser user)

Generates a dynamic ("tagged") link for a given Location without using any id parameter, also the link will be created taking the user's network. This kind of url will be resolved to a static (without any tags) before send the data to the user.

location

java.lang.String location(Location location,
                          java.lang.Long entityId,
                          BasicUser user)

Generates a link for a given Location and entity adding ID parameter in the URL with the entityId value, also the link will be created taking the user's network.

location

java.lang.String location(Location location,
                          java.lang.String idParamName,
                          java.lang.Long entityId,
                          BasicUser user)

Generates a link for a given Location and entity adding the given parameter in the URL with the entityId value, also the link will be created taking the user's network.

login

java.lang.String login(ConfigurationAccessor configuration)

Generates a link to the application login page

mobile

java.lang.String mobile(java.lang.String urlFilePart)

Generates a link to be opened by the Mobile Application for the given Url file part.
E.g cyclos://forgotPassword?key=ZBCXYZ

mobileRedirect

java.lang.String mobileRedirect(java.lang.String urlPart,
                                BasicUser user)

Generates a link which will redirect the user to the mobile application under the given URL part. The default URL is {root}/mobile-redirect/{urlPart}

registrationValidation

java.lang.String registrationValidation(java.lang.String key,
                                        BasicUser user)

Generates a link for the registration validation of the given user. The default URL is {root}/content/users/validateRegistration?key={key}

ticket

java.lang.String ticket(Ticket ticket)

Generates a link for paying the given ticket. The default URL is {root}/pay/{ticket.ticketNumber}