cvs commit: ws-wsrp4j/sandbox/wsrp4j/commons/src/java/org/apache/wsrp4j/commons/consumer/driver GenericWSRPBaseRequestImpl.java PortletKeyImpl.java

[dl...@apache.org]

dlouzan     2005/08/25 09:25:51

  Added:       sandbox/wsrp4j/commons/src/java/org/apache/wsrp4j/commons/consumer/driver
                        GenericWSRPBaseRequestImpl.java PortletKeyImpl.java
  Log:
  Initial commit.
  
  Revision  Changes    Path
  1.1                  ws-wsrp4j/sandbox/wsrp4j/commons/src/java/org/apache/wsrp4j/commons/consumer/driver/GenericWSRPBaseRequestImpl.java
  
  Index: GenericWSRPBaseRequestImpl.java
  ===================================================================
  /*
   * Copyright 2003-2005 The Apache Software Foundation.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.wsrp4j.commons.consumer.driver;
  
  import org.apache.wsrp4j.commons.consumer.interfaces.request.WSRPBaseRequest;
  import org.apache.wsrp4j.commons.log.LogManager;
  import org.apache.wsrp4j.commons.log.Logger;
  
  import oasis.names.tc.wsrp.v1.types.ClientData;
  
  /**
   * @version $Id: GenericWSRPBaseRequestImpl.java,v 1.1 2005/08/25 16:25:51 dlouzan Exp $
   */
  public abstract class GenericWSRPBaseRequestImpl implements WSRPBaseRequest {
      
      protected Logger logger = 
              LogManager.getLogManager().
              getLogger(GenericWSRPBaseRequestImpl.class);
      
      public abstract String getSessionID();
      
      public abstract String getPortletInstanceKey();
      
      public abstract String getNavigationalState();
      
      public abstract String getWindowState();
      
      public abstract String getMode();
      
      public abstract ClientData getClientData();
      
      public abstract String[] getLocales();
      
      public abstract String[] getModes();
      
      public abstract String[] getWindowStates();
      
      public abstract String[] getMimeTypes();
      
      public abstract String[] getCharacterEncodingSet();
      
      public boolean isModeSupported(String wsrpMode) {
          final String MN = "isModeSupported(String)";
          
          if (logger.isLogging(Logger.TRACE_HIGH)) {
              logger.entry(Logger.TRACE_HIGH, MN);
          }
          
          if (wsrpMode == null)
              throw new IllegalArgumentException("mode must not be null");
          
          String[] mods = getModes();
          for (int i = 0; i < mods.length; i++) {
              if (wsrpMode.equalsIgnoreCase(mods[i])) {
                  return true;
              }
          }
          
          if (logger.isLogging(Logger.TRACE_HIGH)) {
              logger.exit(Logger.TRACE_HIGH, MN);
          }
          
          return false;
      }
      
      public boolean isWindowStateSupported(String wsrpWindowState) {
          final String MN = "isWindowStateSupported(String)";
          
          if (logger.isLogging(Logger.TRACE_HIGH)) {
              logger.entry(Logger.TRACE_HIGH, MN);
          }
          
          if (wsrpWindowState == null)
              throw new IllegalArgumentException("window state must not be null");
          
          String[] stats = getWindowStates();
          for (int i = 0; i < stats.length; i++) {
              if (wsrpWindowState.equalsIgnoreCase(stats[i])) {
                  return true;
              }
          }
          
          if (logger.isLogging(Logger.TRACE_HIGH)) {
              logger.exit(Logger.TRACE_HIGH, MN);
          }
          
          return false;
      }
      
      public abstract String getUserAuthentication();
      
  }
  
  
  
  1.1                  ws-wsrp4j/sandbox/wsrp4j/commons/src/java/org/apache/wsrp4j/commons/consumer/driver/PortletKeyImpl.java
  
  Index: PortletKeyImpl.java
  ===================================================================
  /*
   * Copyright 2003-2005 The Apache Software Foundation.
   * 
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
   * 
   *      http://www.apache.org/licenses/LICENSE-2.0
   * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  
  package org.apache.wsrp4j.commons.consumer.driver;
  
  import org.apache.wsrp4j.commons.consumer.interfaces.portlet.PortletKey;
  
  
  /**
   * @version $Id: PortletKeyImpl.java,v 1.1 2005/08/25 16:25:51 dlouzan Exp $
   */
  public class PortletKeyImpl implements PortletKey
  {
  
      private String portletHandle;
      private String producerId;
  
      // constructor for castor persistence
      public PortletKeyImpl()
      {
      }
  
      public PortletKeyImpl(String portletHandle, String producerId)
      {
          this.portletHandle = portletHandle;
          this.producerId = producerId;
      }
  
      /**
       * Get the ID of the producer providing the portlet
       * 
       * @return The ID of the producer
       **/
      public String getProducerId()
      {
          return producerId;
      }
  
      /**
       * Set the ID of the producer providing the portlet
       * 
       * @param id The ID of the producer
       **/
      public void setProducerId(String id)
      {
          producerId = id;
      }
  
      /**
       * Get the portlet handle which identifies an portlet in the scope of one 
       * producer
       *
       * @return The portlet handle
       **/
      public String getPortletHandle()
      {
          return this.portletHandle;
      }
  
      /**
       * Set the portlet handle which identifies an portlet in the scope of one 
       * producer
       *
       * @param portletHandle The portlet handle
       **/
      public void setPortletHandle(String portletHandle)
      {
          if (portletHandle != null)
          {
              this.portletHandle = portletHandle;
          }
      }
  
      /**
       * 
       * 
       */
      public String toString()
      {
  
          String retVal = producerId + "_" + portletHandle;
          return retVal;
      }
      
  }