Package: RequestContext

RequestContext

Coverage

1: /*
2: * *************************************************************************************************************************************************************
3: *
4: * NorthernWind - lightweight CMS
5: * http://tidalwave.it/projects/northernwind
6: *
7: * Copyright (C) 2011 - 2025 Tidalwave s.a.s. (http://tidalwave.it)
8: *
9: * *************************************************************************************************************************************************************
10: *
11: * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12: * You may obtain a copy of the License at
13: *
14: * http://www.apache.org/licenses/LICENSE-2.0
15: *
16: * 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
17: * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
18: *
19: * *************************************************************************************************************************************************************
20: *
21: * git clone https://bitbucket.org/tidalwave/northernwind-src
22: * git clone https://github.com/tidalwave-it/northernwind-src
23: *
24: * *************************************************************************************************************************************************************
25: */
26: package it.tidalwave.northernwind.core.model;
27:
28: import javax.annotation.Nonnull;
29: import it.tidalwave.util.Key;
30: import it.tidalwave.northernwind.core.model.spi.RequestResettable;
31:
32: /***************************************************************************************************************************************************************
33: *
34: * The context for a {@link Request} provides access to some items that are only available during the processing of
35: * the request.
36: *
37: * @author Fabrizio Giudici
38: *
39: **************************************************************************************************************************************************************/
40: public interface RequestContext extends RequestResettable
41: {
42: /***********************************************************************************************************************************************************
43: * Sets the current {@link Content}.
44: *
45: * @param content the current {@code Content}
46: **********************************************************************************************************************************************************/
47: public void setContent (@Nonnull Content content);
48:
49: /***********************************************************************************************************************************************************
50: * Returns the current {@link Content} properties.
51: *
52: * @return the properties
53: **********************************************************************************************************************************************************/
54: @Nonnull
55: public ResourceProperties getContentProperties();
56:
57: /***********************************************************************************************************************************************************
58: * Clears the current {@link Resource}.
59: **********************************************************************************************************************************************************/
60: public void clearContent();
61:
62: /***********************************************************************************************************************************************************
63: * Sets the current {@link SiteNode}.
64: *
65: * @param node the current {@code SiteNode}
66: **********************************************************************************************************************************************************/
67: public void setNode (@Nonnull SiteNode node);
68:
69: /***********************************************************************************************************************************************************
70: * Returns the current {@link SiteNode} properties.
71: *
72: * @return the properties
73: **********************************************************************************************************************************************************/
74: @Nonnull
75: public ResourceProperties getNodeProperties();
76:
77: /***********************************************************************************************************************************************************
78: * Clears the current {@link SiteNode}.
79: **********************************************************************************************************************************************************/
80: public void clearNode();
81:
82: /***********************************************************************************************************************************************************
83: * Sets a dynamic node property. These properties can be associated to the current {@link SiteNode}, created in
84: * a dynamic fashion while processing the {@link Request} and available only in the {@link RequestContext}.
85: *
86: * This property will be made available by {@link #getNodeProperties()}, which e.g. is used by the
87: * {@code $nodeProperty(...)$} macro.
88: *
89: * @param key the property key
90: * @param value the property value
91: **********************************************************************************************************************************************************/
92: public <T> void setDynamicNodeProperty (@Nonnull Key<T> key, @Nonnull T value);
93: }