PortletServices.java |
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 import oasis.names.tc.wsrp.v1.intf.WSRP_v1_PortletManagement_PortType; 25 26 /** 27 * WSRP portlet services are all wsrp service interfaces which 28 * are session dependent. With the implemented version 0.91 of the 29 * WSRP specification the markup interface and the portlet management interface 30 * depend on using the same session cookie in an clustered environment. 31 * 32 * This interface provides a vehicle to store and retrieve the portTypes of these 33 * interfaces. 34 * 35 * @author Stephan Laertz 36 **/ 37 public interface PortletServices { 38 39 /** 40 * Set the portType object of the portlet management service. 41 * 42 * @param portletManagementPortType Port type object which describes the operations of the 43 * producers portlet mamagement service endpoint 44 **/ 45 public void setWSRPPortletManagementService( 46 WSRP_v1_PortletManagement_PortType portletManagementPortType); 47 48 /** 49 * Get a port type object describing the operations of a produces portlet management service 50 * endpoint. 51 * 52 * @return Portlet management port type object 53 **/ 54 public WSRP_v1_PortletManagement_PortType getWSRPPortletManagementService(); 55 56 /** 57 * Set the portType object of the markup service. 58 * 59 * @param markupPortType Port type object which describes the operations of the 60 * producers markup service endpoint 61 **/ 62 public void setWSRPBaseService(WSRP_v1_Markup_PortType markupPortType); 63 64 /** 65 * Get a port type object describing the operations of a produces markup service 66 * endpoint. 67 * 68 * @return Markup port type object 69 **/ 70 public WSRP_v1_Markup_PortType getWSRPBaseService(); 71 72 /** 73 * Get the URL of the producers markup and portlet management service interface. 74 * Since both services can depend on a producer session they need to have the same 75 * accessPoint. 76 * 77 * @return The URL of the producers markup and portlet management service interface. 78 **/ 79 public String getPortletServicesURL(); 80 }