KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > exoplatform > services > wsrp > consumer > InitCookieInfo


1 package org.exoplatform.services.wsrp.consumer;
2
3 import org.exoplatform.services.wsrp.intf.WSRP_v1_Markup_PortType;
4
5 /**
6  * The init cookie information provides a mean to store
7  * information if a <code>InitCookie</code> call is required before
8  * performing any other wsrp call. Since a call of init cookie may
9  * be required only once for a group or a user per producer, this interface also
10  * offers method to check this call has been done already or not.
11  * <p/>
12  * As an initCookie call in WSRP can be required on a per group or
13  * per user basis an object implementing this interface can typically
14  * be hold in a user or group session.
15  * <p/>
16  * Implementations of this interface hold a MarkupPortType stub
17  * to handle cookies correctly
18  *
19  * @author Stephan Laertz
20  * @author <a HREF='mailto:peter.fischer@de.ibm.com'>Peter Fischer</a>
21  * @author Benjamin Mestrallet
22  */
23 public interface InitCookieInfo {
24
25   /**
26    * Check if an initCookie call is generally required. This
27    * does not necessarily say anything if the required initCookie call
28    * has been done already. Use <code>isInitCookieDone</code> for
29    * this purpose.
30    *
31    * @return True if a call of init cookie is generally required.
32    */
33   public boolean isInitCookieRequired();
34
35   /**
36    * Set a boolean value to indicate if an initCookie call
37    * needs to be done.
38    *
39    * @param initCookieRequired True if an initCookie call is generally required
40    */
41   public void setInitCookieRequired(boolean initCookieRequired);
42
43   /**
44    * Check wether a initCookie call has been done already or not.
45    *
46    * @return True if an initCookie has been done already
47    */
48   public boolean isInitCookieDone();
49
50   /**
51    * Set if an initCookie call has been done already or not.
52    *
53    * @param initCookieDone Set to true if the call has been done; false otherwise
54    */
55   public void setInitCookieDone(boolean initCookieDone);
56
57   public String JavaDoc getMarkupInterfaceURL();
58   public WSRP_v1_Markup_PortType getWSRPBaseService();
59   public void setWSRPBaseService(WSRP_v1_Markup_PortType markupPortType);
60
61 }
62
Popular Tags