Return-Path:
- * getRequestForWindow
- *
- * getResponseForWindow
- *
- * Returns any extra path information associated with the URL the
- * client sent when it made this request. The extra path information
- * follows the servlet path but precedes the query string.
- * This method returns null if there was no extra path information.
- *
- * This method should function identically to
- * setPath
- * getPortletRequestForWindow()
before
- * being processed by the portlet container.
- *
- * @return HttpServletRequest
- */
- public HttpServletRequest getRequest();
-
- /**
- * Sets the HTTP Servlet Request. This is the Servlet
- * containers raw request object. This request should
- * be wrapped using getPortletRequestForWindow()
before
- * being processed by the portlet container.
- *
- * @return HttpServletRequest
- */
- public void setRequest(HttpServletRequest request);
-
- /**
- * Gets the HTTP Servlet Response. This is the Servlet
- * containers raw response object. This response should
- * be wrapped using getPortletResponseForWindow()
before
- * being processed by the portlet container.
- * @return HttpServletResponse
- */
- public HttpServletResponse getResponse();
-
- /**
- * Sets the HTTP Servlet Response. This is the Servlet
- * containers raw response object. This response should
- * be wrapped using getPortletResponseForWindow()
before
- * being processed by the portlet container.
- * @return HttpServletResponse
- */
- public void setResponse(HttpServletResponse response);
-
- /**
- * Gets the HTTP Servlet Config
- *
- * @return ServletConfig
- */
- public ServletConfig getConfig();
-
- /**
- * Gets the profile locators for this request
- *
- * @return Profile locators by locator name
- */
- public Map getProfileLocators();
-
- /**
- * Sets the target page profile locators for this request
- *
- * @param locators The target profile locators by locator name
- */
- public void setProfileLocators(Map locators);
-
- /**
- * Gets the target page for this request
- *
- * @return Page
- */
- public ContentPage getPage();
-
- /**
- * Sets the target page for this request
- *
- * @param page The target page
- */
- public void setPage(ContentPage page);
-
- /**
- * Gets the content dispatcher for this request
- *
- * @return ContentDispatcher
- */
- public ContentDispatcher getContentDispatcher();
-
- /**
- * Sets the content dispatcher for this request
- *
- * @param dispatcher The ContentDispatcher to use for this request
- */
- public void setContentDispatcher(ContentDispatcher dispatcher);
-
- /**
- * Set the capabilityMap. Used by the CapabilityValve
- *
- * @param capabilityMap
- */
- public void setCapabilityMap(CapabilityMap map);
-
- /**
- * Get the Capability Map
- *
- */
- public CapabilityMap getCapabilityMap();
-
- /**
- * Set the Mimetype. Set by the CapabilityValve
- *
- * @param mimeType
- */
- public void setMimeType(String mimeType);
-
- /**
- * Get the mimeType for the request
- *
- */
- public String getMimeType();
-
- /**
- * Set the mediaType. Set by the CapabilityValve
- *
- * @param mediaType
- */
- public void setMediaType(String mediaType);
-
- /**
- * get the Media Type
- *
- */
- public String getMediaType();
-
- /**
- * Gets the Portal URL for the current request.
- *
- * @return The Portal URL object for the current request. This method will never
- * return a null
value.
- * @throws IllegalStateException if portalUrl
- * if has not been set.
- */
- public PortalURL getPortalURL();
-
- /**
- * Sets the Portal URL for the current request.
- *
- * @throws IllegalStateException if portalUrl
- * has been set already.
- * @throws IllegalArgumentException if a null value is passed in.
- */
- public void setPortalURL(PortalURL portalUrl);
-
- /**
- * Get the target Action Window
- *
- * @return PortletWindow The target portlet action window
- */
- public PortletWindow getActionWindow();
-
- /**
- * Sets the target Portlet Window
- *
- * @param window
- */
- public void setActionWindow(PortletWindow window);
-
- /**
- * get the character encoding
- *
- *
- */
- public String getCharacterEncoding();
-
- /**
- * set character encoding
- *
- * @param enc
- */
- public void setCharacterEncoding(String enc);
-
- /**
- *
- * HttpServletRequest.getPathInfo()
- * except for that it removes ALL portal/portlet navigational state information from the
- * path info string.
- *
- * getPreferedLanguage - *
- * Returns the Language object for theportlet
which most
- * closely matches the prefences of the currently requesting client.
- *
- * @param portlet
- * @return Language
that matches, as closely as possible, that of
- * the requesting client.
- */
- Language getPreferedLanguage( PortletDefinition portlet );
-
- /**
- *
- * @return
- */
- Throwable popActionFailure(PortletWindow window);
-
-
- /**
- * @param actionFailed The actionFailed to set.
- */
- void setActionFailure(PortletWindow window, Throwable actionFailure);
-
- /**
- * Get the current executing pipeline
- *
- * @return Pipeline
- */
- Pipeline getPipeline();
-
- /**
- * Set the current pipeline
- * @param pipeline
- */
- void setPipeline(Pipeline pipeline);
-
- /**
- * Gets the Jetspeed primary user principal associated with the authorized entity.
- *
- * @return The primary principal on this request.
- */
- Principal getUserPrincipal();
-
- /**
- * Locates a specific page using the profiler and site manager location algorithms
- * from a generalized non-profiled path to the first page matching the path
- *
- * @param profiler The profiler component to use in the search
- * @return A Content Page located by the profiler, or null if not found
- */
- ContentPage locatePage(Profiler profiler, String nonProfiledPath);
-
- /**
- * Return a map of Jetspeed Request Context objects configured via Spring Map
- *
- * @return a Map of request context objects
- * @since 2.1.2
- */
- MapgetPortletRequestForWindow()
before
+ * being processed by the portlet container.
+ *
+ * @return HttpServletRequest
+ */
+ public HttpServletRequest getRequest();
+
+ /**
+ * Sets the HTTP Servlet Request. This is the Servlet
+ * containers raw request object. This request should
+ * be wrapped using getPortletRequestForWindow()
before
+ * being processed by the portlet container.
+ *
+ * @return HttpServletRequest
+ */
+ public void setRequest(HttpServletRequest request);
+
+ /**
+ * Gets the HTTP Servlet Response. This is the Servlet
+ * containers raw response object. This response should
+ * be wrapped using getPortletResponseForWindow()
before
+ * being processed by the portlet container.
+ * @return HttpServletResponse
+ */
+ public HttpServletResponse getResponse();
+
+ /**
+ * Sets the HTTP Servlet Response. This is the Servlet
+ * containers raw response object. This response should
+ * be wrapped using getPortletResponseForWindow()
before
+ * being processed by the portlet container.
+ * @return HttpServletResponse
+ */
+ public void setResponse(HttpServletResponse response);
+
+ /**
+ * Gets the HTTP Servlet Config
+ *
+ * @return ServletConfig
+ */
+ public ServletConfig getConfig();
+
+ /**
+ * Gets the profile locators for this request
+ *
+ * @return Profile locators by locator name
+ */
+ public Map getProfileLocators();
+
+ /**
+ * Sets the target page profile locators for this request
+ *
+ * @param locators The target profile locators by locator name
+ */
+ public void setProfileLocators(Map locators);
+
+ /**
+ * Gets the target page for this request
+ *
+ * @return Page
+ */
+ public ContentPage getPage();
+
+ /**
+ * Sets the target page for this request
+ *
+ * @param page The target page
+ */
+ public void setPage(ContentPage page);
+
+ /**
+ * Gets the content dispatcher for this request
+ *
+ * @return ContentDispatcher
+ */
+ public ContentDispatcher getContentDispatcher();
+
+ /**
+ * Sets the content dispatcher for this request
+ *
+ * @param dispatcher The ContentDispatcher to use for this request
+ */
+ public void setContentDispatcher(ContentDispatcher dispatcher);
+
+ /**
+ * Set the capabilityMap. Used by the CapabilityValve
+ *
+ * @param capabilityMap
+ */
+ public void setCapabilityMap(CapabilityMap map);
+
+ /**
+ * Get the Capability Map
+ *
+ */
+ public CapabilityMap getCapabilityMap();
+
+ /**
+ * Set the Mimetype. Set by the CapabilityValve
+ *
+ * @param mimeType
+ */
+ public void setMimeType(String mimeType);
+
+ /**
+ * Get the mimeType for the request
+ *
+ */
+ public String getMimeType();
+
+ /**
+ * Set the mediaType. Set by the CapabilityValve
+ *
+ * @param mediaType
+ */
+ public void setMediaType(String mediaType);
+
+ /**
+ * get the Media Type
+ *
+ */
+ public String getMediaType();
+
+ /**
+ * Gets the Portal URL for the current request.
+ *
+ * @return The Portal URL object for the current request. This method will never
+ * return a null
value.
+ * @throws IllegalStateException if portalUrl
+ * if has not been set.
+ */
+ public PortalURL getPortalURL();
+
+ /**
+ * Sets the Portal URL for the current request.
+ *
+ * @throws IllegalStateException if portalUrl
+ * has been set already.
+ * @throws IllegalArgumentException if a null value is passed in.
+ */
+ public void setPortalURL(PortalURL portalUrl);
+
+ /**
+ * Get the target Action Window
+ *
+ * @return PortletWindow The target portlet action window
+ */
+ public PortletWindow getActionWindow();
+
+ /**
+ * Sets the target Portlet Window
+ *
+ * @param window
+ */
+ public void setActionWindow(PortletWindow window);
+
+ /**
+ * get the character encoding
+ *
+ *
+ */
+ public String getCharacterEncoding();
+
+ /**
+ * set character encoding
+ *
+ * @param enc
+ */
+ public void setCharacterEncoding(String enc);
+
+ /**
+ *
+ * + * getRequestForWindow + *
+ * + * Takes a PortletWindow and generates a HttpServletRequest that + * accurately represents that PortletWindow's request parameters + * + * + * @param window PortletWindow that we are build a request for + * @return HttpServletRequest that wraps the existing servlet + * container's request that can interpret encoded portlet information + * for this PortletWindow + * + */ + HttpServletRequest getRequestForWindow(PortletWindow window); + + /** + * + *+ * getResponseForWindow + *
+ * + * Takes a PortletWindow and generates a HttpServletResponse that + * accurately represents that PortletWindow's request parameters. + * + * + * @param window PortletWindow that we are build a response for + * @return HttpServletRequest that wraps the existing servlet + * container's request that can interpret encoded portlet information + * for this PortletWindow + * + * + */ + HttpServletResponse getResponseForWindow(PortletWindow window); + + /** + * Gets the subject associated with the authorized entity. + * This subject can be used to provide credentials and principals. + * + * @return The JAAS subject on this request. + */ + Subject getSubject(); + + /** + * Sets the subject associated with the authorized entity. + * This subject can be used to provide credentials and principals. + * + * @param subject The JAAS subject on this request. + */ + void setSubject(Subject subject); + + /** + * Gets the locale associated with this request. + * + * @return The locale associated with this request. + */ + Locale getLocale(); + + /** + * Sets the locale associated with this request. + * + * @param The locale associated with this request. + */ + void setLocale(Locale locale); + + /** + * Use this method to get a request parameter on the generalized request, + * decoupling request parameter manipulation from servlet API. + * This parameter could be on the Http Servlet request, + * in that case it simply passes through to the servlet request. + * + * @param key The parameter unique key + * @return The object associated with the uniqu + */ + String getRequestParameter(String key); + + /** + * Use this method to get a map of request parameters on the generalized request, + * decoupling request parameter manipulation from servlet API. + * The parameters returned could be on the Http Servlet request, + * in that case it simply passes through to the servlet request. + * + * @return + */ + Map getParameterMap(); + + + /** + * Gets an attribute from the session. + * This method is decoupled from the servlet api request to + * facilitate abstractions for testing and other programs not + * connected to a servlet application. + * + * @param key The key of the attribute + * @return The value of the attribute + */ + Object getSessionAttribute(String key); + + /** + * Sets an attribute into the session. + * This method is decoupled from the servlet api request to + * facilitate abstractions for testing and other programs not + * connected to a servlet application. + * + * @param key The key of the session attribute + * @param value The value of the session attribute + */ + void setSessionAttribute(String key, Object value); + + /** + * Get a request attribute associated with this single request. + * + * @param key The key of the request attribute + * @return The value of the request attribute + */ + Object getAttribute(String key); + + /** + * Sets an attribute into the request. + * This method is decoupled from the servlet api request to + * facilitate abstractions for testing and other programs not + * connected to a servlet application. + * + * @param key The key of the request attribute + * @param value The value of the request attribute + */ + void setAttribute(String key, Object value); + + /** + *+ * Returns any extra path information associated with the URL the + * client sent when it made this request. The extra path information + * follows the servlet path but precedes the query string. + * This method returns null if there was no extra path information. + *
+ *
+ * This method should function identically to HttpServletRequest.getPathInfo()
+ * except for that it removes ALL portal/portlet navigational state information from the
+ * path info string.
+ *
+ * setPath + *
+ * Allows the manual overriding of path Jetspeed 2 will look to resolves pages and folders. + * + * @param path + */ + void setPath(String path); + + /** + * Returns the user info map of user attributes for a given portlet application. + * @param appName The portlet application name. + * @return The PortletRequest.USER_INFO map. + */ + Map+ * getPreferedLanguage + *
+ * Returns the Language object for theportlet
which most
+ * closely matches the prefences of the currently requesting client.
+ *
+ * @param portlet
+ * @return Language
that matches, as closely as possible, that of
+ * the requesting client.
+ */
+ Language getPreferedLanguage( PortletDefinition portlet );
+
+ /**
+ *
+ * @return
+ */
+ Throwable popActionFailure(PortletWindow window);
+
+
+ /**
+ * @param actionFailed The actionFailed to set.
+ */
+ void setActionFailure(PortletWindow window, Throwable actionFailure);
+
+ /**
+ * Get the current executing pipeline
+ *
+ * @return Pipeline
+ */
+ Pipeline getPipeline();
+
+ /**
+ * Set the current pipeline
+ * @param pipeline
+ */
+ void setPipeline(Pipeline pipeline);
+
+ /**
+ * Gets the Jetspeed primary user principal associated with the authorized entity.
+ *
+ * @return The primary principal on this request.
+ */
+ Principal getUserPrincipal();
+
+ /**
+ * Locates a specific page using the profiler and site manager location algorithms
+ * from a generalized non-profiled path to the first page matching the path
+ *
+ * @param profiler The profiler component to use in the search
+ * @return A Content Page located by the profiler, or null if not found
+ */
+ ContentPage locatePage(Profiler profiler, String nonProfiledPath);
+
+ /**
+ * Return a map of Jetspeed Request Context objects configured via Spring Map
+ *
+ * @return a Map of request context objects
+ * @since 2.1.2
+ */
+ Map- * Configures an authentication provider. - *
- * - * @author David Le Strat - */ -public interface AuthenticationProvider -{ - - /** - *- * Gets the authentication provider name. - *
- * - * @return The authentication provider name. - */ - String getProviderName(); - - /** - *- * Gets the authentication provider description. - *
- * - * @return The authentication provider description. - */ - String getProviderDescription(); + +/** + *+ * Configures an authentication provider. + *
+ * + * @author David Le Strat + */ +public interface AuthenticationProvider +{ + + /** + *+ * Gets the authentication provider name. + *
+ * + * @return The authentication provider name. + */ + String getProviderName(); + + /** + *+ * Gets the authentication provider description. + *
+ * + * @return The authentication provider description. + */ + String getProviderDescription(); /** *@@ -55,4 +55,4 @@ * @return the {@link AuthenticatedUser} */ AuthenticatedUser authenticate(String userName, String password) throws SecurityException; -} +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthenticationProvider.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthorizationProvider.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthorizationProvider.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthorizationProvider.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthorizationProvider.java Fri Dec 12 04:06:29 2008 @@ -4,47 +4,47 @@ * 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.jetspeed.security; - -import java.util.List; - -/** - *
- * Configures the policies. Instantiates the SecurityPolicies
with the security policies
- * that need to be enforced. It will add the default policy already configured as well as the engine policies
- * used to enforce permission checks.
- *
- * The list of configured policies. - *
- * - * @return The list of policies. - */ - List getPolicies(); - - - /** - *- * Whether to use the default policy or not in addition to the Policies configured for the AuthorizationProvider. - *
- * - * @param whetherToUseDefaultPolicy Boolean false: does not use the default policy, true: does. - */ - void useDefaultPolicy(boolean whetherToUseDefaultPolicy); -} + * 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.jetspeed.security; + +import java.util.List; + +/** + *
+ * Configures the policies. Instantiates the SecurityPolicies
with the security policies
+ * that need to be enforced. It will add the default policy already configured as well as the engine policies
+ * used to enforce permission checks.
+ *
+ * The list of configured policies. + *
+ * + * @return The list of policies. + */ + List getPolicies(); + + + /** + *+ * Whether to use the default policy or not in addition to the Policies configured for the AuthorizationProvider. + *
+ * + * @param whetherToUseDefaultPolicy Boolean false: does not use the default policy, true: does. + */ + void useDefaultPolicy(boolean whetherToUseDefaultPolicy); +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/AuthorizationProvider.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordEncoder.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordEncoder.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordEncoder.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordEncoder.java Fri Dec 12 04:06:29 2008 @@ -4,28 +4,28 @@ * 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.jetspeed.security; - - -/** - *- * CredentialPasswordEncoder - *
- * - * @author Ate Douma - * @version $Id: CredentialPasswordEncoder.java 187914 2004-11-08 22:36:04Z ate $ - */ -public interface CredentialPasswordEncoder -{ - String encode(String userName, String clearTextPassword) throws SecurityException; -} + * 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.jetspeed.security; + + +/** + *+ * CredentialPasswordEncoder + *
+ * + * @author Ate Douma + * @version $Id: CredentialPasswordEncoder.java 187914 2004-11-08 22:36:04Z ate $ + */ +public interface CredentialPasswordEncoder +{ + String encode(String userName, String clearTextPassword) throws SecurityException; +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordEncoder.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordValidator.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordValidator.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordValidator.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordValidator.java Fri Dec 12 04:06:29 2008 @@ -4,28 +4,28 @@ * 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.jetspeed.security; - - -/** - *- * CredentialPasswordValidator - *
- * - * @author Ate Douma - * @version $Id: CredentialPasswordValidator.java 187914 2004-11-08 22:36:04Z ate $ - */ -public interface CredentialPasswordValidator -{ - void validate(String clearTextPassword) throws SecurityException; -} + * 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.jetspeed.security; + + +/** + *+ * CredentialPasswordValidator + *
+ * + * @author Ate Douma + * @version $Id: CredentialPasswordValidator.java 187914 2004-11-08 22:36:04Z ate $ + */ +public interface CredentialPasswordValidator +{ + void validate(String clearTextPassword) throws SecurityException; +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/CredentialPasswordValidator.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/LoginModuleProxy.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/LoginModuleProxy.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/LoginModuleProxy.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/LoginModuleProxy.java Fri Dec 12 04:06:29 2008 @@ -4,48 +4,48 @@ * 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.jetspeed.security; - -/** - *Utility component used as a bridge between the login module and the security component.
- * - * @author David Le Strat - */ -public interface LoginModuleProxy -{ - /** - *Default .portal user role name
- */ - String DEFAULT_PORTAL_USER_ROLE_NAME = "portal-user"; - + * 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.jetspeed.security; + +/** + *Utility component used as a bridge between the login module and the security component.
+ * + * @author David Le Strat + */ +public interface LoginModuleProxy +{ + /** + *Default .portal user role name
+ */ + String DEFAULT_PORTAL_USER_ROLE_NAME = "portal-user"; + /** *Getter for the {@link AuthenticationProvider}.
* @return The AuthenticationProvider */ AuthenticationProvider getAuthenticationProvider(); - /** - *Getter for the {@link UserManager}.
- * @return The UserManager. - */ + /** + *Getter for the {@link UserManager}.
+ * @return The UserManager. + */ UserManager getUserManager(); - /** - *Getter for the required portal user role name.
- * - *Used in web.xml authorization to detect authenticated portal users.
- * - * @return The portal user role name. - */ - String getPortalUserRole(); -} + /** + *Getter for the required portal user role name.
+ * + *Used in web.xml authorization to detect authenticated portal users.
+ * + * @return The portal user role name. + */ + String getPortalUserRole(); +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/LoginModuleProxy.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/security/UserSubjectPrincipal.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/JetspeedSerializer.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/SerializerException.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/SerializerException.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/SerializerException.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/SerializerException.java Fri Dec 12 04:06:29 2008 @@ -4,100 +4,100 @@ * 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.jetspeed.serializer; - -import org.apache.jetspeed.exception.JetspeedException; -import org.apache.jetspeed.i18n.KeyedMessage; - -/** - *Exception throwns by members of the security service.
- * - * @author David Le Strat - */ -public class SerializerException extends JetspeedException -{ - /** The serial version uid. */ - private static final long serialVersionUID = -8823877029853488431L; - - /**Component Manager does not exist exception message.
*/ - public static final KeyedMessage COMPONENTMANAGER_DOES_NOT_EXIST = new KeyedMessage("The component manager {0} does not exist."); - - /**Creating the serilized Object failed
*/ - public static final KeyedMessage GET_EXISTING_OBJECTS = new KeyedMessage("Get existing objects for {0} failed with message {1}"); - - /**Creating the serilized Object failed
*/ - public static final KeyedMessage CREATE_SERIALIZED_OBJECT_FAILED = new KeyedMessage("Creating a serialized representation of {0} failed with message {1}"); - - /**Creating the serilized Object failed
*/ - public static final KeyedMessage CREATE_OBJECT_FAILED = new KeyedMessage("Creating an instance from a serialized representation of {0} failed with message {1}"); - - /**Component Manager already initialized
*/ - public static final KeyedMessage COMPONENT_MANAGER_EXISTS = new KeyedMessage("Component Manager already established"); - - - /**Filename already exists
*/ - public static final KeyedMessage FILE_ALREADY_EXISTS = new KeyedMessage("File {0} already exists"); - - /**Filename already exists
*/ - public static final KeyedMessage FILE_BACKUP_FAILED = new KeyedMessage("File {0} backup failed. Could not create new backup file name."); - - /**io error
*/ - public static final KeyedMessage FILE_PROCESSING_ERROR = new KeyedMessage("Error processing File {0} : {1}"); - /**writer error
*/ - public static final KeyedMessage FILE_WRITER_ERROR = new KeyedMessage("Error creating Writer for {0} : {1}"); - /**reader error
*/ - public static final KeyedMessage FILE_READER_ERROR = new KeyedMessage("Error creating Reader for {0} : {1}"); + * 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.jetspeed.serializer; + +import org.apache.jetspeed.exception.JetspeedException; +import org.apache.jetspeed.i18n.KeyedMessage; + +/** + *Exception throwns by members of the security service.
+ * + * @author David Le Strat + */ +public class SerializerException extends JetspeedException +{ + /** The serial version uid. */ + private static final long serialVersionUID = -8823877029853488431L; + + /**Component Manager does not exist exception message.
*/ + public static final KeyedMessage COMPONENTMANAGER_DOES_NOT_EXIST = new KeyedMessage("The component manager {0} does not exist."); + + /**Creating the serilized Object failed
*/ + public static final KeyedMessage GET_EXISTING_OBJECTS = new KeyedMessage("Get existing objects for {0} failed with message {1}"); + + /**Creating the serilized Object failed
*/ + public static final KeyedMessage CREATE_SERIALIZED_OBJECT_FAILED = new KeyedMessage("Creating a serialized representation of {0} failed with message {1}"); + + /**Creating the serilized Object failed
*/ + public static final KeyedMessage CREATE_OBJECT_FAILED = new KeyedMessage("Creating an instance from a serialized representation of {0} failed with message {1}"); + + /**Component Manager already initialized
*/ + public static final KeyedMessage COMPONENT_MANAGER_EXISTS = new KeyedMessage("Component Manager already established"); + + + /**Filename already exists
*/ + public static final KeyedMessage FILE_ALREADY_EXISTS = new KeyedMessage("File {0} already exists"); + + /**Filename already exists
*/ + public static final KeyedMessage FILE_BACKUP_FAILED = new KeyedMessage("File {0} backup failed. Could not create new backup file name."); + + /**io error
*/ + public static final KeyedMessage FILE_PROCESSING_ERROR = new KeyedMessage("Error processing File {0} : {1}"); + /**writer error
*/ + public static final KeyedMessage FILE_WRITER_ERROR = new KeyedMessage("Error creating Writer for {0} : {1}"); + /**reader error
*/ + public static final KeyedMessage FILE_READER_ERROR = new KeyedMessage("Error creating Reader for {0} : {1}"); /**import error
*/ public static final KeyedMessage IMPORT_ERROR = new KeyedMessage("Unexpected error during import: {0}"); - + /**export error
*/ public static final KeyedMessage EXPORT_ERROR = new KeyedMessage("Unexpected error during export: {0}"); - /**version problem - version in XML file is not compatible with current environment
*/ - public static final KeyedMessage INCOMPETIBLE_VERSION = new KeyedMessage("Incompetible version in {0} : CurrentVersion = {1}, RequestedVersion = {2}"); - - - /** - *Default Constructor.
- */ - public SerializerException() - { - super(); - } - - public SerializerException(Throwable t) - { - super(t); - } - - /** - *Constructor with exception message.
- * @param message The exception message. - */ - public SerializerException(KeyedMessage typedMessage) - { - super(typedMessage); - } - - /** - *Constructor with exception message and nested exception.
- * @param msg The exception message. - * @param nested Nested exception. - */ - public SerializerException(KeyedMessage msg, Throwable nested) - { - super(msg, nested); - } - -} + /**version problem - version in XML file is not compatible with current environment
*/ + public static final KeyedMessage INCOMPETIBLE_VERSION = new KeyedMessage("Incompetible version in {0} : CurrentVersion = {1}, RequestedVersion = {2}"); + + + /** + *Default Constructor.
+ */ + public SerializerException() + { + super(); + } + + public SerializerException(Throwable t) + { + super(t); + } + + /** + *Constructor with exception message.
+ * @param message The exception message. + */ + public SerializerException(KeyedMessage typedMessage) + { + super(typedMessage); + } + + /** + *Constructor with exception message and nested exception.
+ * @param msg The exception message. + * @param nested Nested exception. + */ + public SerializerException(KeyedMessage msg, Throwable nested) + { + super(msg, nested); + } + +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/serializer/SerializerException.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/sso/SSOCookie.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/AggregateStatistics.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/AggregateStatistics.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/AggregateStatistics.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/AggregateStatistics.java Fri Dec 12 04:06:29 2008 @@ -4,51 +4,51 @@ * 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.jetspeed.statistics; - -import java.io.Serializable; -import java.util.List; -import java.util.Map; - -/** - * AggregateStatistics - * - * @author Chris Schaefer - * @author David Sean Taylor - * @version $Id: $ - */ -public interface AggregateStatistics extends Serializable -{ - - public void addRow(Map row); - - public int getHitCount(); - - public float getAvgProcessingTime(); - - public float getMinProcessingTime(); - - public float getMaxProcessingTime(); - - public void setHitCount(int hitCount); - - public void setAvgProcessingTime(float time); - - public void setMinProcessingTime(float time); - - public void setMaxProcessingTime(float time); - - public List getStatlist(); - - public void setStatlist(List statlist); -} + * 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.jetspeed.statistics; + +import java.io.Serializable; +import java.util.List; +import java.util.Map; + +/** + * AggregateStatistics + * + * @author Chris Schaefer + * @author David Sean Taylor + * @version $Id: $ + */ +public interface AggregateStatistics extends Serializable +{ + + public void addRow(Map row); + + public int getHitCount(); + + public float getAvgProcessingTime(); + + public float getMinProcessingTime(); + + public float getMaxProcessingTime(); + + public void setHitCount(int hitCount); + + public void setAvgProcessingTime(float time); + + public void setMinProcessingTime(float time); + + public void setMaxProcessingTime(float time); + + public List getStatlist(); + + public void setStatlist(List statlist); +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/AggregateStatistics.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/InvalidCriteriaException.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/InvalidCriteriaException.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/InvalidCriteriaException.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/InvalidCriteriaException.java Fri Dec 12 04:06:29 2008 @@ -4,30 +4,30 @@ * 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.jetspeed.statistics; - -/** - * InvalidCriteriaException - * - * @author Chris Schaefer - * @author David Sean Taylor - * @version $Id: $ - */ -public class InvalidCriteriaException extends Exception -{ - - public InvalidCriteriaException(String mesg) - { - super(mesg); - } -} + * 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.jetspeed.statistics; + +/** + * InvalidCriteriaException + * + * @author Chris Schaefer + * @author David Sean Taylor + * @version $Id: $ + */ +public class InvalidCriteriaException extends Exception +{ + + public InvalidCriteriaException(String mesg) + { + super(mesg); + } +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/InvalidCriteriaException.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/PortalStatistics.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/PortalStatistics.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/PortalStatistics.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/PortalStatistics.java Fri Dec 12 04:06:29 2008 @@ -4,169 +4,169 @@ * 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.jetspeed.statistics; - -import java.util.List; - -import javax.sql.DataSource; - -import org.apache.jetspeed.request.RequestContext; - -/** - * The PortletStatistics interface provides an API for logging portlet - * statistics. Each log entry is formatted in the Apache Common Log Format (CLF) - * . Each CLF log entry has the following form: - *- * "%h %l %u %t \"%r\" %>s %b" - *
- * where: - *
- * Here's an example of a CLF log entry: - *
- * - *
- * - * 192.168.2.3 - johndoe [25/Oct/2005:11:44:40 PDT] "GET - * /jetspeed/DatabaseBrowserTest HTTP/1.1" 200 - - * - *- * - *
- * The PortletStatistics interface overloads the %r field of the CLF format, - * depending on the type of information being logged: - *
- * - *
- * - * LOG TYPE FORMAT OF %r FIELD -------------- ---------------------------- - * Portlet access "PORTLET- * - * @author David Sean Taylor - * @author Mark Orciuch - * @author Richard Klein - * @version $Id: $ - */ -public interface PortalStatistics -{ - public static final String QUERY_TYPE_PORTLET = "portlet"; - public static final String QUERY_TYPE_USER = "user"; - public static final String QUERY_TYPE_PAGE = "page"; - - public static final String HTTP_OK = "200"; - - public static final String HTTP_UNAUTHORIZED = "401"; - - public static final String HTTP_NOT_FOUND = "404"; - - public static final String HTTP_INTERNAL_ERROR = "500"; - - /** - * Logs an access to a portlet. - * - * @param request - * current request info object - * @param portlet - * portlet being logged - * @param statusCode - * HTTP status code. - * @param msElapsedTime - * elapsed time the portlet took to render - */ - public void logPortletAccess(RequestContext request, String portlet, - String statusCode, long msElapsedTime); - - /** - * Logs an access to a page. - * - * @param request - * current request info object - * @param statusCode - * HTTP status code - * @param msElapsedTime - * elapsed time the page took to render - */ - public void logPageAccess(RequestContext request, String statusCode, - long msElapsedTime); - - /** - * Logs a user logout event. The %s (HTTP status code) field of the log - * entry will be set to 200 (OK). - * - * @param request - * current request info object - * @param msElapsedTime - * elapsed time that the user was logged in - */ - public void logUserLogout(String ipAddress, String userName, - long msSessionLength); - - /** - * Logs a user logout event. The %s (HTTP status code) field of the log - * entry will be set to 200 (OK). - * - * @param request - * current request info object - * @param msElapsedLoginTime - * time it took the user to login - */ - public void logUserLogin(RequestContext request, long msElapsedLoginTime); - - /** - * @return returns the current number of logged in users - */ - public int getNumberOfCurrentUsers(); - - /** - * force the database loggers to flush out - */ - public void forceFlush(); - - /** - * @return DataSource in use by the logger useful for writing decent tests - */ - public DataSource getDataSource(); - - public AggregateStatistics queryStatistics(StatisticsQueryCriteria criteria) - throws InvalidCriteriaException; - - public int getNumberOfLoggedInUsers(); - - public List getListOfLoggedInUsers(); - - /** - * Factory to create new statistics query criteria - * - * @return a newly create statistics empty criteria - */ - public StatisticsQueryCriteria createStatisticsQueryCriteria(); - - /** - * Factory to create new, empty, aggregate statistics object. - * - * @return unpopulated AggregateStatistics object - */ - public AggregateStatistics getDefaultEmptyAggregateStatistics(); -} + * 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.jetspeed.statistics; + +import java.util.List; + +import javax.sql.DataSource; + +import org.apache.jetspeed.request.RequestContext; + +/** + * The PortletStatistics interface provides an API for logging portlet + * statistics. Each log entry is formatted in the Apache Common Log Format (CLF) + * . Each CLF log entry has the following form: + *" Page access "PAGE - * " User logout "LOGOUT" - * - *
+ * "%h %l %u %t \"%r\" %>s %b" + *
+ * where: + *
+ * Here's an example of a CLF log entry: + *
+ * + *
+ * + * 192.168.2.3 - johndoe [25/Oct/2005:11:44:40 PDT] "GET + * /jetspeed/DatabaseBrowserTest HTTP/1.1" 200 - + * + *+ * + *
+ * The PortletStatistics interface overloads the %r field of the CLF format, + * depending on the type of information being logged: + *
+ * + *
+ * + * LOG TYPE FORMAT OF %r FIELD -------------- ---------------------------- + * Portlet access "PORTLET+ * + * @author David Sean Taylor + * @author Mark Orciuch + * @author Richard Klein + * @version $Id: $ + */ +public interface PortalStatistics +{ + public static final String QUERY_TYPE_PORTLET = "portlet"; + public static final String QUERY_TYPE_USER = "user"; + public static final String QUERY_TYPE_PAGE = "page"; + + public static final String HTTP_OK = "200"; + + public static final String HTTP_UNAUTHORIZED = "401"; + + public static final String HTTP_NOT_FOUND = "404"; + + public static final String HTTP_INTERNAL_ERROR = "500"; + + /** + * Logs an access to a portlet. + * + * @param request + * current request info object + * @param portlet + * portlet being logged + * @param statusCode + * HTTP status code. + * @param msElapsedTime + * elapsed time the portlet took to render + */ + public void logPortletAccess(RequestContext request, String portlet, + String statusCode, long msElapsedTime); + + /** + * Logs an access to a page. + * + * @param request + * current request info object + * @param statusCode + * HTTP status code + * @param msElapsedTime + * elapsed time the page took to render + */ + public void logPageAccess(RequestContext request, String statusCode, + long msElapsedTime); + + /** + * Logs a user logout event. The %s (HTTP status code) field of the log + * entry will be set to 200 (OK). + * + * @param request + * current request info object + * @param msElapsedTime + * elapsed time that the user was logged in + */ + public void logUserLogout(String ipAddress, String userName, + long msSessionLength); + + /** + * Logs a user logout event. The %s (HTTP status code) field of the log + * entry will be set to 200 (OK). + * + * @param request + * current request info object + * @param msElapsedLoginTime + * time it took the user to login + */ + public void logUserLogin(RequestContext request, long msElapsedLoginTime); + + /** + * @return returns the current number of logged in users + */ + public int getNumberOfCurrentUsers(); + + /** + * force the database loggers to flush out + */ + public void forceFlush(); + + /** + * @return DataSource in use by the logger useful for writing decent tests + */ + public DataSource getDataSource(); + + public AggregateStatistics queryStatistics(StatisticsQueryCriteria criteria) + throws InvalidCriteriaException; + + public int getNumberOfLoggedInUsers(); + + public List getListOfLoggedInUsers(); + + /** + * Factory to create new statistics query criteria + * + * @return a newly create statistics empty criteria + */ + public StatisticsQueryCriteria createStatisticsQueryCriteria(); + + /** + * Factory to create new, empty, aggregate statistics object. + * + * @return unpopulated AggregateStatistics object + */ + public AggregateStatistics getDefaultEmptyAggregateStatistics(); +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/PortalStatistics.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/StatisticsQueryCriteria.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/StatisticsQueryCriteria.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/StatisticsQueryCriteria.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/StatisticsQueryCriteria.java Fri Dec 12 04:06:29 2008 @@ -4,51 +4,51 @@ * 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.jetspeed.statistics; - -import java.io.Serializable; - -/** - * StatisticsQueryCriteria - * - * @author Chris Schaefer - * @author David Sean Taylor - * @version $Id: $ - */ -public interface StatisticsQueryCriteria extends Serializable -{ - - public String getTimePeriod(); - - public void setTimePeriod(String timePeriod); - - public String getUser(); - - public void setUser(String user); - - public void setQueryType(String queryType); - - public String getQueryType(); - - public String getListsize(); - - public String getSorttype(); - - public void setListsize(String listsize); - - public void setSorttype(String sorttype); - - public void setSortorder(String sortorder); - - public String getSortorder(); -} + * 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.jetspeed.statistics; + +import java.io.Serializable; + +/** + * StatisticsQueryCriteria + * + * @author Chris Schaefer + * @author David Sean Taylor + * @version $Id: $ + */ +public interface StatisticsQueryCriteria extends Serializable +{ + + public String getTimePeriod(); + + public void setTimePeriod(String timePeriod); + + public String getUser(); + + public void setUser(String user); + + public void setQueryType(String queryType); + + public String getQueryType(); + + public String getListsize(); + + public String getSorttype(); + + public void setListsize(String listsize); + + public void setSorttype(String sorttype); + + public void setSortorder(String sortorder); + + public String getSortorder(); +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/StatisticsQueryCriteria.java ------------------------------------------------------------------------------ svn:eol-style = native Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/statistics/UserStats.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeRetrievalException.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeRetrievalException.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeRetrievalException.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeRetrievalException.java Fri Dec 12 04:06:29 2008 @@ -4,30 +4,30 @@ * 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.jetspeed.userinfo; - -/** - * User Attribute Retrieval Exceptions - * - * @author Keith Garry Boyce - * @author David Sean Taylor - * @version $Id: $ - */ -public class UserAttributeRetrievalException extends Exception -{ - public UserAttributeRetrievalException(Exception e) - { - super(e); - } - -} + * 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.jetspeed.userinfo; + +/** + * User Attribute Retrieval Exceptions + * + * @author Keith Garry Boyce + * @author David Sean Taylor + * @version $Id: $ + */ +public class UserAttributeRetrievalException extends Exception +{ + public UserAttributeRetrievalException(Exception e) + { + super(e); + } + +} Propchange: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeRetrievalException.java ------------------------------------------------------------------------------ svn:eol-style = native Modified: portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeSource.java URL: http://svn.apache.org/viewvc/portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeSource.java?rev=725977&r1=725976&r2=725977&view=diff ============================================================================== --- portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeSource.java (original) +++ portals/jetspeed-2/portal/trunk/jetspeed-api/src/main/java/org/apache/jetspeed/userinfo/UserAttributeSource.java Fri Dec 12 04:06:29 2008 @@ -4,36 +4,36 @@ * 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.jetspeed.userinfo; - - -import java.util.Collection; -import java.util.Map; - -import javax.security.auth.Subject; - + * 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.jetspeed.userinfo; + + +import java.util.Collection; +import java.util.Map; + +import javax.security.auth.Subject; + import org.apache.jetspeed.om.portlet.UserAttributeRef; -import org.apache.jetspeed.request.RequestContext; - -/** - * Required Interface for a User Attribute Source - * - * @author Keith Garry Boyce - * @author David Sean Taylor - * @version $Id: $ - */ -public interface UserAttributeSource -{ - Map" Page access "PAGE + * " User logout "LOGOUT" + * + *