Package org.cyclos.impl.utils

Interface LinkGeneratorHandler

  • All Known Implementing Classes:
    LinkGeneratorHandlerImpl
    public interface LinkGeneratorHandler
    Generates links for various URLs in Cyclos

    • Field Detail

      • 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_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. The default URL is {root}/external-redirect-callback/{maskId(ere.getId()}/{ere.getVerificationToken()}

      • customWizardExternalRedirect

        String customWizardExternalRedirect​(CustomWizardExecution execution,
                                    CustomWizardExecutionStorage storage)
        Generates a link for a custom wizard external redirect execution. The default URL is {root}/wizard-external-callback/{execution.getKey()}

      • 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}

      • forgotPassword

        String forgotPassword​(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

        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.

      • 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://forgotPassword?key=ZBCXYZ

      • mobileRedirect

        String mobileRedirect​(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

        String registrationValidation​(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

        String ticket​(Ticket ticket)
        Generates a link for paying the given ticket. The default URL is {root}/pay/{ticket.ticketNumber}