blob: d5fba794a7872eec6686ceae8d06668a27be95cd (
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
|
/*
* Jitsi, the OpenSource Java VoIP and Instant Messaging client.
*
* Distributable under LGPL license.
* See terms of license at gnu.org.
*/
package net.java.sip.communicator.service.protocol;
/**
* This class is used to represent both incoming and outgoing
* AuthorizationResponse-s
* <p>
* An outgoing Authorization Response is to be created by the user interface
* when an authorization request has been received from the network. The user
* interface or any other bundle responsible of handling such responses is to
* implement the AuthoizationHandler interface and register itself with a
* protocol provider. Whenever a response needs to be sent the protocol provider
* would ask the the AuthorizationHandler to create one through the
* processAuthorizationRequest() method.
* <p>
* Incoming Authorization responses are delivered to the AuthorizationHandler
* implementation through the AuthorizationHandler.processAuthorizationResponse()
* method.
*
* @author Emil Ivov
*/
public class AuthorizationResponse
{
/**
* Indicates that the source authorization request which this response is
* about has been accepted and that the requestor may now proceed to adding
* the user to their contact list.
*/
public static final AuthorizationResponseCode ACCEPT
= new AuthorizationResponseCode("service.gui.ACCEPT");
/**
* Indicates that source authorization request which this response is about
* has been rejected. A reason may also have been specified.
*/
public static final AuthorizationResponseCode REJECT
= new AuthorizationResponseCode("Reject");
/**
* Indicates that source authorization request which this response is about
* has been ignored and that no other indication will be sent to the
* requestor.
*/
public static final AuthorizationResponseCode IGNORE
= new AuthorizationResponseCode("Ignore");
/**
* A reason indication that the source user may or may not add to explaining
* the response.
*/
private String reason = null;
/**
* Authorization response codes represent unambiguous indication of the way
* a user or a remote party have acted upon an authorization request.
*/
private AuthorizationResponseCode responseCode = null;
/**
* Creates an instance of an AuthorizationResponse with the specified
* responseCode and reason.
* @param responseCode AuthorizationResponseCode
* @param reason String
*/
public AuthorizationResponse(AuthorizationResponseCode responseCode,
String reason)
{
this.reason = reason;
this.responseCode = responseCode;
}
/**
* Returns a String containing additional explanations (might also be empty)
* of this response.
* @return the reason the source user has given to explain this resonse and
* null or an empty string if no reason has been specified.
*/
public String getReason()
{
return reason;
}
/**
* Returns the response code that unambiguously represents the sense of this
* response.
*
* @return an AuthorizationResponseResponseCode instance determining the
* nature of the response.
*/
public AuthorizationResponseCode getResponseCode()
{
return responseCode;
}
/**
* Authorization response codes represent unambiguous indication of the way
* a user or a remote party have acted upon an authorization request.
*/
public static class AuthorizationResponseCode
{
private final String code;
private AuthorizationResponseCode(String code)
{
this.code = code;
}
/**
* Returns the string contents representing this code.
* @return a String representing the code.
*/
public String getCode()
{
return code;
}
}
}
|
