View Javadoc

1   /***
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    * 
9    *     http://www.apache.org/licenses/LICENSE-2.0
10   * 
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.jetspeed.serializer;
18  
19  
20  /***
21   * Jetspeed Serializer Factory
22   * 
23   * <p>Interface for creating serializers. Serializer keep some state so they should be recreated as needed
24   * We will revisit this class in the refactoring in 2.2 as Im not really sure why we need a primary and secondary class
25   *  but I think its related to the dependencies fixed in these issues, see:
26   * http://issues.apache.org/jira/browse/JS2-771 and http://issues.apache.org/jira/browse/JS2-770 
27   * </p> 
28   */
29  public interface JetspeedSerializerFactory
30  {
31  
32      /*** Create basic Jetspeed Serializer */
33      public final static String PRIMARY = "primary";
34      /*** Create a secondary Jetspeed Serializer (registry data) */
35      public final static String SECONDARY = "secondary";
36      
37      /***
38       * Create a Jetspeed Serializer of one of the two supported types
39       * @param serializerType eithe PRIMARY OR SECONDARY
40       * @return
41       */
42      public JetspeedSerializer create(String serializerType);
43      
44  }