1   /*
2    * Copyright 2000-2001,2004 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    * 
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  
17  /* 
18  
19   */
20  
21  package org.apache.wsrp4j.consumer;
22  
23  import oasis.names.tc.wsrp.v1.intf.WSRP_v1_Markup_PortType;
24  
25  /**
26   * The init cookie information provides a mean to store
27   * information if a <code>InitCookie</code> call is required before 
28   * performing any other wsrp call. Since a call of init cookie may
29   * be required only once for a group or a user per producer, this interface also
30   * offers method to check this call has been done already or not.
31   * 
32   * As an initCookie call in WSRP can be required on a per group or
33   * per user basis an object implementing this interface can typically
34   * be hold in a user or group session.
35   * 
36   * Implementations of this interface hold a MarkupPortType stub
37   * to handle cookies correctly
38   * 
39   * @author Stephan Laertz
40   * @author <a href='mailto:peter.fischer@de.ibm.com'>Peter Fischer</a>
41   **/
42  public interface InitCookieInfo {
43  
44      /**
45       * Check if an initCookie call is generally required. This
46       * does not necessarily say anything if the required initCookie call
47       * has been done already. Use <code>isInitCookieDone</code> for 
48       * this purpose.
49       * 
50       * @return True if a call of init cookie is generally required.
51       **/
52      public boolean isInitCookieRequired();
53  
54      /**
55       * Set a boolean value to indicate if an initCookie call
56       * needs to be done.
57       * 
58       * @param initCookieRequired True if an initCookie call is generally required
59       **/
60      public void setInitCookieRequired(boolean initCookieRequired);
61  
62      /**
63       * Check wether a initCookie call has been done already or not.
64       * 
65       * @return True if an initCookie has been done already
66       **/
67      public boolean isInitCookieDone();
68  
69      /**
70       * Set if an initCookie call has been done already or not.
71       * 
72       * @param initCookieDone Set to true if the call has been done; false otherwise
73       **/
74      public void setInitCookieDone(boolean initCookieDone);
75  
76      /**
77       * Get the markup interface URL
78       * 
79       * @return the markup interface URL
80       **/
81      public String getMarkupInterfaceURL();
82  
83      /**
84       * Get the markup interface portType
85       * 
86       * @return the markup interface portType
87       **/
88      public WSRP_v1_Markup_PortType getWSRPBaseService();
89  
90      /**
91       * set the markup interface portType
92       * 
93       * @param markupPortType the markup interface portType
94       **/
95      public void setWSRPBaseService(WSRP_v1_Markup_PortType markupPortType);
96  }