URLTemplateComposer


1   package org.exoplatform.services.wsrp.consumer;
2   
3   /**
4    * <p>This interface provides methods to generate URL templates.</p>
5    * <p>The generated templates will be transmitted to Producers (or respectively portlets)
6    * that are willing to properly write URLs for a Consumer. (With templates the Consumer
7    * indicates how it needs URLs formatted in order to process them properly.)</p>
8    *
9    * @author <a HREF="mailto:stefan.behl@de.ibm.com">Stefan Behl</a>
10   * @author Benjamin Mestrallet
11   */
12  public interface URLTemplateComposer {
13  
14    public void setHost(String   host);
15    public void setPort(int port);
16  
17    /**
18     * Creates a blocking action template. Includes tokens for url-type, portletMode,
19     * navigationalState, interactionState and windowState to be replaced by the producer.
20     *
21     * @return String representing the entire template.
22     * @param path
23     */
24    public String   createBlockingActionTemplate(String   path);
25  
26    /**
27     * Creates a secure blocking action template. Includes tokens for url-type,
28     * portletMode, navigationalState, interactionState, windowState and secureURL to be replaced by
29     * the producer.
30     *
31     * @return String representing the entire template.
32     */
33    public String   createSecureBlockingActionTemplate(String   path);
34  
35    /**
36     * Creates a render template. Includes tokens for url-type, portletMode,
37     * navigationalState, interactionState and windowState to be replaced by the producer.
38     *
39     * @return String representing the entire template.
40     */
41    public String   createRenderTemplate(String   path);
42  
43    /**
44     * Creates a secure render template. Includes tokens for url-type, portletMode,
45     * navigationalState, interactionState, windowState and secureURL to be replaced by the producer.
46     *
47     * @return String representing the entire template.
48     */
49    public String   createSecureRenderTemplate(String   path);
50  
51    /**
52     * Creates a resource template. Includes tokens for url-type,
53     * rewriteResource and url to be replaced by the producer.
54     *
55     * @return String representing the entire template.
56     */
57    public String   createResourceTemplate(String   path);
58  
59    /**
60     * Creates a secure resource template. Includes tokens for url-type, url,
61     * rewriteResource, and secureURL to be replaced by the producer.
62     *
63     * @return String representing the entire template.
64     */
65    public String   createSecureResourceTemplate(String   path);
66  
67    /**
68     * Creates a default template. Includes tokens for url-type, portletMode,
69     * navigationalState, interactionState, windowState, url, rewriteResource
70     * and secureURL to be replaced by the producer.
71     *
72     * @return String representing the entire template.
73     */
74    public String   createDefaultTemplate(String   path);
75  
76    /**
77     * Creates a secure default template. Includes tokens for url-type, portletMode,
78     * navigationalState, interactionState, windowState, url, rewriteResource and secureURL
79     * to be replaced by the producer.
80     *
81     * @return String representing the entire template.
82     */
83    public String   createSecureDefaultTemplate(String   path);
84  
85    /**
86     * Get the consumers namespace prefix which is used by the portlet
87     * to namespace tokens which need to be unique on a aggregated page.
88     *
89     * @return The namespace prefix of the consumer.
90     */
91    public String   getNamespacePrefix();
92  }
93
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags