Coverage Report

Coverage Report - org.apache.myfaces.portlet.PortletUtil

Classes in this File

Line Coverage

Branch Coverage

Complexity

PortletUtil

0/6

0/4

1.667

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you 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.myfaces.portlet;
 
 
 import javax.faces.context.FacesContext;
 import javax.portlet.RenderResponse;
 
 /**
  * Static utility class for portlet-related operations.
  *
  * @author  Stan Silvert
  */
 public final class PortletUtil {
     
         /** This flag is imbedded in the request.
          *  It signifies to MyFaces that the request is coming from a portlet.
          */
         public static final String PORTLET_REQUEST_FLAG = 
            PortletUtil.class.getName() + ".PORTLET_REQUEST_FLAG";
     
         /** Don't allow a new instance of PortletUtil */
         private PortletUtil() {
         }
         
         /**
          * Determine if we are processing a portlet RenderResponse.
          *
          * @param facesContext The current FacesContext.
          * @return <code>true</code> if we are processing a RenderResponse,
          *         <code>false</code> otherwise.
          */
         public static boolean isRenderResponse(FacesContext facesContext) {
             if (!isPortletRequest(facesContext)) return false;
             
             return facesContext.getExternalContext().getResponse() instanceof RenderResponse;
         }
         
         /**
          * Determine if we are running as a portlet.
          *
          * @param facesContext The current FacesContext.
          * @return <code>true</code> if we are running as a portlet,
          *         <code>false</code> otherwise.
          */
         public static boolean isPortletRequest(FacesContext facesContext) {
             return facesContext.getExternalContext()
                                .getSessionMap()
                                .get(PORTLET_REQUEST_FLAG) != null;
         }
     }

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		package org.apache.myfaces.portlet;
20
21
22		import javax.faces.context.FacesContext;
23		import javax.portlet.RenderResponse;
24
25		/**
26		* Static utility class for portlet-related operations.
27		*
28		* @author Stan Silvert
29		*/
30		public final class PortletUtil {
31
32		/** This flag is imbedded in the request.
33		* It signifies to MyFaces that the request is coming from a portlet.
34		*/
35	0	public static final String PORTLET_REQUEST_FLAG =
36		PortletUtil.class.getName() + ".PORTLET_REQUEST_FLAG";
37
38		/** Don't allow a new instance of PortletUtil */
39	0	private PortletUtil() {
40	0	}
41
42		/**
43		* Determine if we are processing a portlet RenderResponse.
44		*
45		* @param facesContext The current FacesContext.
46		* @return <code>true</code> if we are processing a RenderResponse,
47		* <code>false</code> otherwise.
48		*/
49		public static boolean isRenderResponse(FacesContext facesContext) {
50	0	if (!isPortletRequest(facesContext)) return false;
51
52	0	return facesContext.getExternalContext().getResponse() instanceof RenderResponse;
53		}
54
55		/**
56		* Determine if we are running as a portlet.
57		*
58		* @param facesContext The current FacesContext.
59		* @return <code>true</code> if we are running as a portlet,
60		* <code>false</code> otherwise.
61		*/
62		public static boolean isPortletRequest(FacesContext facesContext) {
63	0	return facesContext.getExternalContext()
64		.getSessionMap()
65		.get(PORTLET_REQUEST_FLAG) != null;
66		}
67		}