1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
* Copyright 2002-2012 the original author or authors.
*
* Licensed 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.springframework.web.portlet.context;
import org.springframework.web.context.support.RequestHandledEvent;
/**
* Portlet-specific subclass of RequestHandledEvent,
* adding portlet-specific context information.
*
* @author Juergen Hoeller
* @author John A. Lewis
* @since 2.0
* @see org.springframework.web.portlet.FrameworkPortlet
* @see org.springframework.context.ApplicationContext#publishEvent
*/
@SuppressWarnings("serial")
public class PortletRequestHandledEvent extends RequestHandledEvent {
/** Name of the portlet that handled the request */
private final String portletName;
/** PortletMode of the request */
private final String portletMode;
/** Type of Portlet Request */
private final String requestType;
/**
* Create a new PortletRequestHandledEvent.
* @param source the component that published the event
* @param portletName the name of the portlet that handled the request
* @param portletMode the PortletMode of the request (usually 'view', 'edit', or 'help')
* @param requestType the type of Portlet request ('action' or 'render')
* @param sessionId the id of the HTTP session, if any
* @param userName the name of the user that was associated with the
* request, if any (usually the UserPrincipal)
* @param processingTimeMillis the processing time of the request in milliseconds
*/
public PortletRequestHandledEvent(Object source, String portletName,
String portletMode, String requestType, String sessionId,
String userName, long processingTimeMillis) {
super(source, sessionId, userName, processingTimeMillis);
this.portletName = portletName;
this.portletMode = portletMode;
this.requestType = requestType;
}
/**
* Create a new PortletRequestHandledEvent.
* @param source the component that published the event
* @param portletName the name of the portlet that handled the request
* @param portletMode the PortletMode of the request (usually 'view', 'edit', or 'help')
* @param requestType the type of Portlet request ('action' or 'render')
* @param sessionId the id of the HTTP session, if any
* @param userName the name of the user that was associated with the
* request, if any (usually the UserPrincipal)
* @param processingTimeMillis the processing time of the request in milliseconds
* @param failureCause the cause of failure, if any
*/
public PortletRequestHandledEvent(Object source, String portletName,
String portletMode, String requestType, String sessionId,
String userName, long processingTimeMillis, Throwable failureCause) {
super(source, sessionId, userName, processingTimeMillis, failureCause);
this.portletName = portletName;
this.portletMode = portletMode;
this.requestType = requestType;
}
/**
* Return the name of the portlet that handled the request.
*/
public String getPortletName() {
return this.portletName;
}
/**
* Return the mode of the portlet request (usually 'view', 'edit', or 'help').
*/
public String getPortletMode() {
return this.portletMode;
}
/**
* Return the type of Portlet Request ('action' or 'render').
*/
public String getRequestType() {
return this.requestType;
}
@Override
public String getShortDescription() {
StringBuilder sb = new StringBuilder();
sb.append("portlet=[").append(this.portletName).append("]; ");
sb.append(super.getShortDescription());
return sb.toString();
}
@Override
public String getDescription() {
StringBuilder sb = new StringBuilder();
sb.append("portlet=[").append(this.portletName).append("]; ");
sb.append("mode=[").append(this.portletMode).append("]; ");
sb.append("type=[").append(this.requestType).append("]; ");
sb.append(super.getDescription());
return sb.toString();
}
@Override
public String toString() {
return "PortletRequestHandledEvent: " + getDescription();
}
}
|
