com.pega.pegarules.pub.session.url

Interface PegaURLBuilder

public interface PegaURLBuilder

PegaURLBuilder is used to construct Pega URLs in various formats. Based on the specified methods it identifies individual URL components and then constructs the final URL.

 This can used to build the following types of URLs 
        1) External URLs: These are links that are shared with other users to give access to specified object/process. For example: E-mail link to open a work object. 
        - Getting an instance of external URL builder: pega.getExternalURLBuilder();
        - Typical format of external URLs: http://host:port/prweb/{servlet}/app/{appAlias}
        2) Current Session URLs: These are links that will be used by the same user, same web session in order to access an object/process. 
           For example: Static content image link in the web application. These URLs need the current context like app alias, cookies etc. 
           Generally Pega Platform will take care of building such URLs but some custom rules which go out of the model may require this support. 
        - Getting an instance of current session URL builder: pega.getCurrentSessionURLBuilder()
        - Typical format of current session URLs: http://host:port/prweb/{servlet}/app/{appAlias}/{Access Group Hash}/{Thread Name or Static content directory}/

 Use necessary combination of methods to construct required Pega URLs.
        For example:
        - To generate email links
                a.pega.getExternalURLBuilder().useCurrentContext().currentServlet().currentApplication().build();
                b.Generated URL sample : http://host:port/prweb/PRServlet/app/TestApp
        - To generate mashup URLs, which requires unique Pega session.
                a.pega.getExternalURLBuilder().useCurrentContext().currentServlet().currentApplicationWithUniqueId().build();
                b.Generated URL sample : http://host:port/prweb/PRServlet/app/TestApp_1212
        - To generate application URLs with authentication alias
                a.pega.getExternalURLBuilder().useCurrentContext().withAuthenticationAlias("authAlias").currentApplication().build();
                b.Generated URL sample : http://host:port/prweb/PRAuth/app/AppAlias/authAlias
        - To generate static content URLs which can be accessed in current session.
                a.pega.getCurrentSessionURLBuilder().currentAccessGroup().staticContent().build();
                b.Generated URL sample : http://host:port/prweb/app/TestApp_/z9TwsFgrP5T_i0ULWyqfeAGRYGrYSWAmXg2-aEDs9JI%28*/ServiceExport
        
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	PegaURLBuilder.IAccessGroupComponent PegaURLBuilder.IAccessGroupComponent is used to construct access group hash in the complete Pega URL. Refer PegaURLBuilder for constructing Pega URLs. This class is used to construct bold component in Pega URL as shown below: http://{hostname}:{port}/prweb/{ServletName}/app/{ApplicationAlias}_1234/{Access Group Hash}/{Thread Name or Static content directory}/
static interface	PegaURLBuilder.IApplicationAliasComponent PegaURLBuilder.IApplicationAliasComponent is used to construct application alias part in the complete Pega URL. Refer PegaURLBuilder for constructing Pega URLs. This class is used to construct bold component in Pega URL as shown below: http://{hostname}:{port}/prweb/{ServletName}/app/{ApplicationAlias}_1234/{Access Group Hash}/{Thread Name or Static content directory}/
static interface	PegaURLBuilder.IBuilder PegaURLBuilder.IBuilder is used to construct complete Pega URL. Refer PegaURLBuilder for constructing Pega URLs.
static interface	PegaURLBuilder.IServletComponent PegaURLBuilder.IServletComponent is used to construct servlet name in the complete Pega URL. Refer PegaURLBuilder for constructing Pega URLs. This class is used to construct bold component in Pega URL as shown below: http://{hostname}:{port}/prweb/{ServletName}/app/{ApplicationAlias}_1234/{Access Group Hash}/{Thread Name or Static content directory}/
static interface	PegaURLBuilder.IThreadComponent PegaURLBuilder.IThreadComponent is used to construct thread name in the complete Pega URL. Refer PegaURLBuilder for constructing Pega URLs. This class is used to construct bold component in Pega URL as shown below: http://{hostname}:{port}/prweb/{ServletName}/app/{ApplicationAlias}_1234/{Access Group Hash}/{Thread Name or Static content directory}/

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	VERSION

Method Summary

Modifier and Type	Method and Description
PegaURLBuilder.IServletComponent	useCurrentContext() Adds base URL component from current application context. http://www.pega.com/prweb
PegaURLBuilder.IApplicationAliasComponent	usePublicLink() Adds base URL component from pxPublicLinkURL property. http://www.pega.com/prweb or http://www.pega.com/prweb/PRServlet

Field Detail

VERSION

static final java.lang.String VERSION

Method Detail

usePublicLink

PegaURLBuilder.IApplicationAliasComponent usePublicLink()

Adds base URL component from pxPublicLinkURL property.

http://www.pega.com/prweb or http://www.pega.com/prweb/PRServlet

Returns:

PegaURLBuilder.IApplicationAliasComponent An instance to build application alias

useCurrentContext

PegaURLBuilder.IServletComponent useCurrentContext()

Adds base URL component from current application context.

http://www.pega.com/prweb

Returns:

PegaURLBuilder.IServletComponent An instance to build application alias