Package org.cyclos.impl.utils

Interface LinkGeneratorHandler

  • public interface LinkGeneratorHandler
    Generates links for various URLs in Cyclos

    • Field Detail

      • PATH_IDENTITY_PROVIDER_REDIRECT

        static final String PATH_IDENTITY_PROVIDER_REDIRECT
        API path that will redirect to the identity provider
        See Also:
        Constant Field Values

      • PATH_IDENTITY_PROVIDER_CALLBACK

        static final String PATH_IDENTITY_PROVIDER_CALLBACK
        API path where the identity provider will be redirected after authorization is performed (accepted/rejected)
        See Also:
        Constant Field Values

      • PARAM_INVITE_TOKEN

        static final String PARAM_INVITE_TOKEN
        Parameter with the invite token used in the invite url.
        See Also:
        Constant Field Values

      • UI_PATH_OPERATION_EXTERNAL_REDIRECT

        static final String UI_PATH_OPERATION_EXTERNAL_REDIRECT
        Path to the custom operation external redirect callback page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_WIZARD_EXTERNAL_REDIRECT

        static final String UI_PATH_WIZARD_EXTERNAL_REDIRECT
        Path to the custom wizard external redirect callback page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_NOTIFICATION

        static final String UI_PATH_NOTIFICATION
        Path to the notification redirect page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_REPLAY_MESSAGE

        static final String UI_PATH_REPLAY_MESSAGE
        Path to the reply message page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_VALIDATE_REGISTRATION

        static final String UI_PATH_VALIDATE_REGISTRATION
        Path to the validate registration page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_VALIDATE_EMAIL_CHANGE

        static final String UI_PATH_VALIDATE_EMAIL_CHANGE
        Path to the validate e-mail change page in the new frontend.
        See Also:
        Constant Field Values

      • UI_PATH_WIZARD_EXECUTION

        static final String UI_PATH_WIZARD_EXECUTION
        Path to the custom wizard execution page in the new frontend.
        See Also:
        Constant Field Values

      • ATTR_UNSUBSCRIBE_EMAIL_KEY

        static final String ATTR_UNSUBSCRIBE_EMAIL_KEY
        Script attribute: the e-mail unsubscription key
        See Also:
        Constant Field Values

      • ATTR_UNSUBSCRIBE_EMAIL_TYPE

        static final String ATTR_UNSUBSCRIBE_EMAIL_TYPE
        Script attribute: the e-mail unsubscription type
        See Also:
        Constant Field Values

      • ATTR_ENTITY_ID

        static final 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 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 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 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 String ATTR_EXTERNAL_REDIRECT_EXECUTION
        Script attribute: the external redirect execution for custom operations
        See Also:
        Constant Field Values

      • ATTR_EXECUTION

        static final String ATTR_EXECUTION
        Script attribute: the wizard execution for external redirects
        See Also:
        Constant Field Values

      • ATTR_STORAGE

        static final String ATTR_STORAGE
        Script attribute: the wizard execution storage for external redirects
        See Also:
        Constant Field Values

      • ATTR_IDENTITY_PROVIDER

        static final String ATTR_IDENTITY_PROVIDER
        Script attribute: the identity provider
        See Also:
        Constant Field Values

      • ATTR_REQUEST_ID

        static final String ATTR_REQUEST_ID
        Script attribute: the identity provider request id
        See Also:
        Constant Field Values

      • ATTR_PAYMENT_AMOUNT

        static final String ATTR_PAYMENT_AMOUNT
        Script attribute: the easy invoice amount
        See Also:
        Constant Field Values

      • ATTR_PAYMENT_TYPE

        static final String ATTR_PAYMENT_TYPE
        Script attribute: the easy invoice payment type
        See Also:
        Constant Field Values

      • ATTR_PAYMENT_CURRENCY

        static final String ATTR_PAYMENT_CURRENCY
        Script attribute: the easy invoice payment currency
        See Also:
        Constant Field Values

      • ATTR_PAYMENT_DESCRIPTION

        static final String ATTR_PAYMENT_DESCRIPTION
        Script attribute: the easy invoice payment description
        See Also:
        Constant Field Values

      • ATTR_PAYMENT_CUSTOM_VALUES

        static final String ATTR_PAYMENT_CUSTOM_VALUES
        Script attribute: the easy invoice payment custom field values
        See Also:
        Constant Field Values

    • Method Detail

      • customOperationExternalRedirect

        String customOperationExternalRedirect​(ExternalRedirectExecution ere)
        Generates a link for a custom operation external redirect execution.

      • emailChange

        String emailChange​(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}

      • home

        String home​(BasicUser user)
        Generates a link for the home of the given user.

      • identityProviderCallback

        String identityProviderCallback​(IdentityProvider provider)
        Generates a link representing the callback URL that the provider must redirect to after the authorization is performed (accepted/rejected)

      • identityProviderRedirect

        String identityProviderRedirect​(IdentityProvider provider,
                                String requestId)
        Generates a link for the popup which will redirect the user to the identity provider authorization page

      • invite

        String invite​(InviteToken inviteToken)
        Generates a link for the invitation email to register the invited user with the corresponding token

      • location

        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

        String location​(Location location,
                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

        String location​(Location location,
                String idParamName,
                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.

      • location

        String location​(Location location,
                String keyParamName,
                String entityKey,
                BasicUser user)
        Generates a link for a given Location and entity adding the given parameter in the URL with the entityKey value, also the link will be created taking the user's network.

      • login

        String login​(BasicUser user)
        Generates a link to the application login page

      • mobile

        String mobile​(String urlFilePart)
        Generates a link to be opened directly by the Mobile Application for the given Url file part.
        E.g cyclos://history?id=account_id

      • mobileRedirect

        String mobileRedirect​(String urlPart,
                      BasicUser user)
        Generates a link which will redirect the user to the mobile application under the given URL part.

      • mobileScheme

        String mobileScheme()
        Returns the current mobile scheme. E.g cyclos://

      • registrationValidation

        String registrationValidation​(String key,
                              BasicUser user)
        Generates a link for the registration validation of the given user.

      • registrationWithExternalPayment

        String registrationWithExternalPayment​(ExternalPayment externalPayment)
        Generates a link for registration with the given external payment

      • replyMessage

        String replyMessage​(IncomingMessage replyTo)
        Generates a link for replying a given message

      • root

        String root​(BasicUser user)
        Generates a link for the root URL for the given user, or default if the user is null

      • ticket

        String ticket​(Ticket ticket)
        Generates a link for paying the given ticket.

      • voucherInfo

        String voucherInfo()
        Generates a link for the root of the voucher information page

      • voucherInfo

        String voucherInfo​(Voucher voucher)
        Generates a link for the voucher information page for a specific voucher