1 files changed, 76 insertions, 0 deletions
diff --git a/java/broker/src/main/java/org/apache/qpid/server/security/auth/SubjectAuthenticationResult.java b/java/broker/src/main/java/org/apache/qpid/server/security/auth/SubjectAuthenticationResult.java
new file mode 100644
index 0000000000..3be96b87eb
--- /dev/null
+++ b/java/broker/src/main/java/org/apache/qpid/server/security/auth/SubjectAuthenticationResult.java
@@ -0,0 +1,76 @@
+/*
+ *
+ * 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.auth;
+
+import java.security.Principal;
+
+import javax.security.auth.Subject;
+
+import org.apache.qpid.server.security.SubjectCreator;
+
+/**
+ * Encapsulates the result of an attempt to authenticate using a {@link SubjectCreator}.
+ *
+ * <p>
+ * iff authentication was successful, {@link #getSubject()} will return a non-null value and
+ * {@link #getStatus()} will return {@link AuthenticationResult.AuthenticationStatus#SUCCESS}.
+ *
+ * In this case, the {@link Subject} will contain the user {@link Principal} and zero or more other principals
+ * representing groups.
+ * </p>
+ * @see SubjectCreator
+ */
+public class SubjectAuthenticationResult
+{
+    private final AuthenticationResult _authenticationResult;
+    private final Subject _subject;
+
+    public SubjectAuthenticationResult(AuthenticationResult authenticationResult, Subject subject)
+    {
+        _authenticationResult = authenticationResult;
+        _subject = subject;
+    }
+
+    public SubjectAuthenticationResult(AuthenticationResult unsuccessfulAuthenticationResult)
+    {
+        this(unsuccessfulAuthenticationResult, null);
+    }
+
+    public Exception getCause()
+    {
+        return _authenticationResult.getCause();
+    }
+
+    public AuthenticationResult.AuthenticationStatus getStatus()
+    {
+        return _authenticationResult.getStatus();
+    }
+
+    public byte[] getChallenge()
+    {
+        return _authenticationResult.getChallenge();
+    }
+
+    public Subject getSubject()
+    {
+        return _subject;
+    }
+}