blob: e0fb1eca2f6d361e3d2b4777314175b3cf8712be (
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
|
/*
*
* 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.server.protocol;
import javax.security.sasl.SaslServer;
import org.apache.qpid.AMQException;
import org.apache.qpid.framing.AMQDataBlock;
import org.apache.qpid.framing.AMQShortString;
import org.apache.qpid.framing.FieldTable;
import org.apache.qpid.protocol.AMQVersionAwareProtocolSession;
import org.apache.qpid.server.AMQChannel;
import org.apache.qpid.server.virtualhost.VirtualHost;
public interface AMQProtocolSession extends AMQVersionAwareProtocolSession
{
public static interface Task
{
public void doTask(AMQProtocolSession session) throws AMQException;
}
/**
* Called when a protocol data block is received
* @param message the data block that has been received
* @throws Exception if processing the datablock fails
*/
void dataBlockReceived(AMQDataBlock message) throws Exception;
/**
* Get the context key associated with this session. Context key is described
* in the AMQ protocol specification (RFC 6).
* @return the context key
*/
AMQShortString getContextKey();
/**
* Set the context key associated with this session. Context key is described
* in the AMQ protocol specification (RFC 6).
* @param contextKey the context key
*/
void setContextKey(AMQShortString contextKey);
/**
* Get the channel for this session associated with the specified id. A channel
* id is unique per connection (i.e. per session).
* @param channelId the channel id which must be valid
* @return null if no channel exists, the channel otherwise
*/
AMQChannel getChannel(int channelId) throws AMQException;
/**
* Associate a channel with this session.
* @param channel the channel to associate with this session. It is an error to
* associate the same channel with more than one session but this is not validated.
*/
void addChannel(AMQChannel channel) throws AMQException;
/**
* Close a specific channel. This will remove any resources used by the channel, including:
* <ul><li>any queue subscriptions (this may in turn remove queues if they are auto delete</li>
* </ul>
* @param channelId id of the channel to close
* @throws org.apache.qpid.AMQException if an error occurs closing the channel
* @throws IllegalArgumentException if the channel id is not valid
*/
void closeChannel(int channelId) throws AMQException;
/**
* Remove a channel from the session but do not close it.
* @param channelId
*/
void removeChannel(int channelId);
/**
* Initialise heartbeats on the session.
* @param delay delay in seconds (not ms)
*/
void initHeartbeats(int delay);
/**
* This must be called when the session is _closed in order to free up any resources
* managed by the session.
*/
void closeSession() throws AMQException;
/**
* @return a key that uniquely identifies this session
*/
Object getKey();
/**
* Get the fully qualified domain name of the local address to which this session is bound. Since some servers
* may be bound to multiple addresses this could vary depending on the acceptor this session was created from.
*
* @return a String FQDN
*/
String getLocalFQDN();
/**
* @return the sasl server that can perform authentication for this session.
*/
SaslServer getSaslServer();
/**
* Set the sasl server that is to perform authentication for this session.
* @param saslServer
*/
void setSaslServer(SaslServer saslServer);
FieldTable getClientProperties();
void setClientProperties(FieldTable clientProperties);
Object getClientIdentifier();
VirtualHost getVirtualHost();
void setVirtualHost(VirtualHost virtualHost) throws AMQException;
void addSessionCloseTask(Task task);
void removeSessionCloseTask(Task task);
}
|
