java/broker/src/main/java/org/apache/qpid/server/security/AuthorizationHolder.java


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

/*
 *
 * 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.security;

import javax.security.auth.Subject;
import java.security.Principal;

/**
 * Represents the authorization of the logged on user. 
 * 
 */
public interface AuthorizationHolder
{
    /** 
     * Returns the {@link Subject} of the authorized user.  This is guaranteed to
     * contain at least one {@link org.apache.qpid.server.security.auth.sasl.UsernamePrincipal}, representing the the identity
     * used when the user logged on to the application, and zero or more {@link org.apache.qpid.server.security.auth.sasl.GroupPrincipal}
     * representing the group(s) to which the user belongs.
     *
     * @return the Subject
     */
    Subject getAuthorizedSubject();

    /** 
     * Returns the {@link Principal} representing the the identity
     * used when the user logged on to the application.
     * 
     * @return a Principal
     */
    Principal getAuthorizedPrincipal();
}