View Javadoc

1   /*
2    *  Copyright 2006 Simon Raess
3    *
4    *  Licensed under the Apache License, Version 2.0 (the "License");
5    *  you may not use this file except in compliance with the License.
6    *  You may obtain a copy of the License at
7    *
8    *      http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   *  Unless required by applicable law or agreed to in writing, software
11   *  distributed under the License is distributed on an "AS IS" BASIS,
12   *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   *  See the License for the specific language governing permissions and
14   *  limitations under the License.
15   */
16  package net.sf.beep4j;
17  
18  /**
19   * The StartSessionRequest is used when establishing a session to
20   * register profiles or to cancel the session.
21   * 
22   * @author Simon Raess 
23   */
24  public interface StartSessionRequest {
25  	
26  	/**
27  	 * Registers a profile URI, which will be advertised as part
28  	 * of the greeting element. This method may be called zero or
29  	 * more times, depending on how many profiles the peer wants to
30  	 * advertise.
31  	 * 
32  	 * @param profileUri the profile URI to be advertised
33  	 */
34  	void registerProfile(String profileUri);
35  	
36  	/**
37  	 * Cancels the Session by sending an error element in a negative reply.
38  	 * The error code is 421. The meaning of this code is 'service not available'.
39  	 */
40  	void cancel();
41  	
42  }