summaryrefslogtreecommitdiff
path: root/java/management/client/src/main/java/org/apache/qpid/management/jmx/OperationHasBeenInvokedNotification.java
blob: dec29c1b93fcf03219c826a7946dc214f3622d35 (plain)
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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
/*
 *
 * 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.qpid.management.jmx;

import javax.management.Notification;

import org.apache.qpid.management.Names;
import org.apache.qpid.management.domain.handler.impl.InvocationResult;
import org.apache.qpid.management.domain.services.SequenceNumberGenerator;

/**
 * Q-Man JMX method invocation notification.
 * This kind of notification is sent to interested listener by Q-Man when 
 * a method has been invoked (Method invocation request)
 * 
 * @author Andrea Gazzarini
 */
public class OperationHasBeenInvokedNotification extends Notification
{
	private static final long serialVersionUID = -7755773156742412161L;
	public static final String NOTIFICATION_TYPE = "org.apache.qpid.management.operation.invoked";
	
	private final String _operationName;
	private final Object [] _parameters;
	private final String [] _signature;
	private final Exception _exception;
	private final InvocationResult _result;
	
	/**
	 * Builds a new notification with the given parameters.
	 * 
	 * @param type the notification type.
	 * @param operationName the operation name.
	 * @param params the operation parameters.
	 * @param signature the operation signature.
	 * @param exception the exception raised by the invocation.
	 */
	public OperationHasBeenInvokedNotification(
			String operationName, 
			Object[] parameters, 
			String [] signature, 
			Exception exception) 
	{
		super(
				NOTIFICATION_TYPE,
				Names.APPLICATION_NAME,
				SequenceNumberGenerator.getNextSequenceNumber());
		
		this._operationName= operationName;
		this._parameters = parameters;
		this._signature = signature;		
		this._result = null;
		this._exception = exception;
	}

	/**
	 * Builds a new notification with the given parameters.
	 * 
	 * @param type the notification type.
	 * @param operationName the operation name.
	 * @param params the operation parameters.
	 * @param signature the operation signature.
	 * @param objectName the target mbean object name.
	 * @param result the invocation result.
	 */
	public OperationHasBeenInvokedNotification(
			String operationName, 
			Object[] parameters, 
			String [] signature,
			InvocationResult result) 
	{
		super(
				NOTIFICATION_TYPE,
				Names.APPLICATION_NAME,
				SequenceNumberGenerator.getNextSequenceNumber());
		
		this._operationName= operationName;
		this._parameters = parameters;
		this._signature = signature;
		this._result = result;
		this._exception = null;
	}
	
	/**
	 * Returns the exception raised by this notification 
	 * referred operation.
	 * 
	 * @return the exception raised by this notification referred operation.
	 */
	public Exception getException()
	{
		return _exception;
	}
	
	/**
	 * Returns the exception raised by this notification 
	 * referred operation.
	 * 
	 * @return the exception raised by this notification referred operation.
	 */
	public InvocationResult getResult()
	{
		return _result;
	}
	
	/**
	 * Returns the operation name.
	 * 
	 * @return the operation name.
	 */
	public String getOperationName()
	{
		return _operationName;
	}
	
	/**
	 * Returns the parameters used in method invocation.
	 * 
	 * @return the parameters used in method invocation.
	 */
	public Object [] getParameters()
	{
		return _parameters;
	}

	/**
	 * Returns the signature of the invoked operation.
	 * 
	 * @return the signature of the invoked operation.
	 */
	public String [] getSignature()
	{
		return _signature;
	}
	
	/**
	 * Returns a string representation of this notification.
	 * 
	 * @return a string representation of this notification.
	 */
	@Override
	public String toString()
	{
		return new StringBuilder()
			.append(getType())
			.append(':')
			.append(_operationName)
			.toString();
	}
}