View Javadoc

1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one
3    * or more contributor license agreements.  See the NOTICE file
4    * distributed with this work for additional information
5    * regarding copyright ownership.  The ASF licenses this file
6    * to you under the Apache License, Version 2.0 (the
7    * "License"); you may not use this file except in compliance
8    * with the License.  You may obtain a copy of the License at
9    *
10   *   http://www.apache.org/licenses/LICENSE-2.0
11   *
12   * Unless required by applicable law or agreed to in writing,
13   * software distributed under the License is distributed on an
14   * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   * KIND, either express or implied.  See the License for the
16   * specific language governing permissions and limitations
17   * under the License.
18   */
19  
20  package org.apache.myfaces.tobago.portlet;
21  
22  import javax.portlet.PortletRequest;
23  
24  /**
25   * Static utility class for portlet-related operations.
26   */
27  public final class PortletUtils {
28  
29    private static final boolean PORTLET_API_AVAILABLE;
30  
31    static {
32      boolean result;
33      try {
34        result = PortletRequest.class != null;
35      } catch (final NoClassDefFoundError e) {
36        result = false;
37      }
38      PORTLET_API_AVAILABLE = result;
39    }
40  
41    private PortletUtils() {
42      // avoid instantiation
43    }
44  
45    /**
46     * The Portlet API is optional in the class path. We are only allowed to check instance of e. g. PortletRequest,
47     * if the API exists.
48     *
49     * @return Are the Portlet classes available?
50     */
51    public static boolean isPortletApiAvailable() {
52      return PORTLET_API_AVAILABLE;
53    }
54  
55  }