View Javadoc

1   /**
2    * This file Copyright (c) 2008-2012 Magnolia International
3    * Ltd.  (http://www.magnolia-cms.com). All rights reserved.
4    *
5    *
6    * This file is dual-licensed under both the Magnolia
7    * Network Agreement and the GNU General Public License.
8    * You may elect to use one or the other of these licenses.
9    *
10   * This file is distributed in the hope that it will be
11   * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12   * implied warranty of MERCHANTABILITY or FITNESS FOR A
13   * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14   * Redistribution, except as permitted by whichever of the GPL
15   * or MNA you select, is prohibited.
16   *
17   * 1. For the GPL license (GPL), you can redistribute and/or
18   * modify this file under the terms of the GNU General
19   * Public License, Version 3, as published by the Free Software
20   * Foundation.  You should have received a copy of the GNU
21   * General Public License, Version 3 along with this program;
22   * if not, write to the Free Software Foundation, Inc., 51
23   * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24   *
25   * 2. For the Magnolia Network Agreement (MNA), this file
26   * and the accompanying materials are made available under the
27   * terms of the MNA which accompanies this distribution, and
28   * is available at http://www.magnolia-cms.com/mna.html
29   *
30   * Any modifications to this file must keep this entire header
31   * intact.
32   *
33   */
34  package info.magnolia.module.templatingkit;
35  
36  import info.magnolia.cms.core.AggregationState;
37  import info.magnolia.context.MgnlContext;
38  import info.magnolia.module.templatingkit.sites.Site;
39  
40  /**
41   * Aggregates additional information to render content. Filled-in progressively by various filters.
42   * @author had
43   * @version $Id$
44   */
45  public class ExtendedAggregationState extends AggregationState {
46  
47      private String domainName;
48      private String remoteHost;
49      private String remoteAddr;
50      private String domainAddr;
51      private Site site;
52      private boolean crossSiteAccess = false;
53  
54      public static ExtendedAggregationState getInstance() {
55          return (ExtendedAggregationState) MgnlContext.getAggregationState();
56      }
57  
58      /**
59       * @param domainName The name of the domain used in the request.
60       */
61      public void setDomainName(String domainName) {
62          this.domainName = domainName;
63      }
64  
65      /**
66       * @param remoteHost The domain name of the requesting host.
67       */
68      public void setRemoteHost(String remoteHost) {
69          this.remoteHost = remoteHost;
70      }
71  
72      /**
73       * @param domainAddr The IP address of the resolved request.
74       */
75      public void setDomainAddr(String domainAddr) {
76          this.domainAddr = domainAddr;
77      }
78  
79      /**
80       * @param remoteAddr The IP address of the requesting host.
81       */
82      public void setRemoteAddr(String remoteAddr) {
83          this.remoteAddr = remoteAddr;
84      }
85  
86      /**
87       * Gets site configuration assigned to the current request.
88       * @return Site configuration.
89       */
90      public Site getSite() {
91          return site;
92      }
93  
94      /**
95       * Sets site configuration for the current request.
96       * @param site Site configuration.
97       */
98      public void setSite(Site site) {
99          this.site = site;
100     }
101 
102     public String getDomainName() {
103         return domainName;
104     }
105 
106     public String getRemoteHost() {
107         return remoteHost;
108     }
109 
110     public String getRemoteAddr() {
111         return remoteAddr;
112     }
113 
114     public String getDomainAddr() {
115         return domainAddr;
116     }
117 }