Skip to content

Commit

Permalink
Merge pull request #123 from arjantijms/tabs_to_spaces
Browse files Browse the repository at this point in the history
Change over tabs to spaces according to the Jakarta code convention
  • Loading branch information
arjantijms committed Nov 28, 2021
2 parents d565138 + e2e8303 commit 5b44640
Show file tree
Hide file tree
Showing 21 changed files with 1,657 additions and 1,657 deletions.
34 changes: 17 additions & 17 deletions api/src/main/java/jakarta/security/auth/message/AuthException.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,23 +23,23 @@
*/
public class AuthException extends javax.security.auth.login.LoginException {

private static final long serialVersionUID = -1156951780670243758L;
private static final long serialVersionUID = -1156951780670243758L;

/**
* Constructs an AuthException with no detail message. A detail message is a String that describes this particular
* exception.
*/
public AuthException() {
super();
}
/**
* Constructs an AuthException with no detail message. A detail message is a String that describes this particular
* exception.
*/
public AuthException() {
super();
}

/**
* Constructs an AuthException with the specified detail message. A detail message is a String that describes this
* particular exception.
*
* @param msg The detail message.
*/
public AuthException(String msg) {
super(msg);
}
/**
* Constructs an AuthException with the specified detail message. A detail message is a String that describes this
* particular exception.
*
* @param msg The detail message.
*/
public AuthException(String msg) {
super(msg);
}
}
92 changes: 46 additions & 46 deletions api/src/main/java/jakarta/security/auth/message/AuthStatus.java
Original file line number Diff line number Diff line change
Expand Up @@ -24,57 +24,57 @@
*/
public class AuthStatus {

/**
* Indicates that the message processing by the authentication module was successful and that the runtime is to proceed
* with its normal processing of the resulting message.
*/
public static final AuthStatus SUCCESS = new AuthStatus(1);
/**
* Indicates that the message processing by the authentication module was successful and that the runtime is to proceed
* with its normal processing of the resulting message.
*/
public static final AuthStatus SUCCESS = new AuthStatus(1);

/**
* Indicates that the message processing by the authentication module was NOT successful, and that the module replaced
* the application message with an error message.
*/
public static final AuthStatus FAILURE = new AuthStatus(2);
/**
* Indicates that the message processing by the authentication module was NOT successful, and that the module replaced
* the application message with an error message.
*/
public static final AuthStatus FAILURE = new AuthStatus(2);

/**
* Indicates that the message processing by the authentication module was successful and that the runtime is to proceed
* by sending a message returned by the authentication module.
*/
public static final AuthStatus SEND_SUCCESS = new AuthStatus(3);
/**
* Indicates that the message processing by the authentication module was successful and that the runtime is to proceed
* by sending a message returned by the authentication module.
*/
public static final AuthStatus SEND_SUCCESS = new AuthStatus(3);

/**
* Indicates that the message processing by the authentication module was NOT successful, that the module replaced the
* application message with an error message, and that the runtime is to proceed by sending the error message.
*/
public static final AuthStatus SEND_FAILURE = new AuthStatus(4);
/**
* Indicates that the message processing by the authentication module was NOT successful, that the module replaced the
* application message with an error message, and that the runtime is to proceed by sending the error message.
*/
public static final AuthStatus SEND_FAILURE = new AuthStatus(4);

/**
* Indicates the message processing by the authentication module is NOT complete, that the module replaced the
* application message with a security message, and that the runtime is to proceed by sending the security message.
*/
public static final AuthStatus SEND_CONTINUE = new AuthStatus(5);
/**
* Indicates the message processing by the authentication module is NOT complete, that the module replaced the
* application message with a security message, and that the runtime is to proceed by sending the security message.
*/
public static final AuthStatus SEND_CONTINUE = new AuthStatus(5);

private final int value;
private final int value;

private AuthStatus(int value) {
this.value = value;
}
private AuthStatus(int value) {
this.value = value;
}

@Override
public String toString() {
switch (value) {
case 1:
return "AuthStatus.SUCCESS";
case 2:
return "AuthStatus.FAILURE";
case 3:
return "AuthStatus.SEND_SUCCESS";
case 4:
return "AuthStatus.SEND_FAILURE";
case 5:
return "AuthStatus.SEND_CONTINUE";
default:
return "Unknown AuthStatus";
}
}
@Override
public String toString() {
switch (value) {
case 1:
return "AuthStatus.SUCCESS";
case 2:
return "AuthStatus.FAILURE";
case 3:
return "AuthStatus.SEND_SUCCESS";
case 4:
return "AuthStatus.SEND_FAILURE";
case 5:
return "AuthStatus.SEND_CONTINUE";
default:
return "Unknown AuthStatus";
}
}
}
206 changes: 103 additions & 103 deletions api/src/main/java/jakarta/security/auth/message/ClientAuth.java
Original file line number Diff line number Diff line change
Expand Up @@ -28,109 +28,109 @@
*/
public interface ClientAuth {

/**
* Secure a service request message before sending it to the service.
*
* <p>
* This method is called to transform the request message acquired by calling getRequestMessage (on messageInfo) into
* the mechanism-specific form to be sent by the runtime.
*
* <p>
* This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an
* AuthException.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param clientSubject A Subject that represents the source of the service request, or null. It may be used by the
* method implementation as the source of Principals or credentials to be used to secure the request. If the Subject is
* not null, the method implementation may add additional Principals or credentials (pertaining to the source of the
* service request) to the Subject.
*
* @return An AuthStatus object representing the completion status of the processing performed by the method. The
* AuthStatus values that may be returned by this method are defined as follows:
* <ul>
* <li>AuthStatus.SUCCESS when the application request message was successfully secured. The secured request message may
* be obtained by calling getRequestMessage on messageInfo.
*
* <li>AuthStatus.SEND_CONTINUE to indicate that the application request message (within messageInfo) was replaced with
* a security message that should elicit a security-specific response from the peer security system. This status value
* also indicates that the application message has not yet been secured.
*
* This status value serves to inform the calling runtime that (to successfully complete the message exchange) it will
* need to be capable of continuing the message dialog by conducting at least one additional request/response exchange
* after having received the security-specific response elicited by sending the security message.
*
* When this status value is returned, the corresponding invocation of <code>validateResponse</code> must be able to
* obtain the original application request message.
*
* <li>AuthStatus.FAILURE to indicate that a failure occured while securing the request message, and that an appropriate
* failure response message is available by calling getResponseMessage on messageInfo.
* </ul>
*
* @exception AuthException When the message processing failed without establishing a failure response message (in
* messageInfo).
*/
AuthStatus secureRequest(MessageInfo messageInfo, Subject clientSubject) throws AuthException;
/**
* Secure a service request message before sending it to the service.
*
* <p>
* This method is called to transform the request message acquired by calling getRequestMessage (on messageInfo) into
* the mechanism-specific form to be sent by the runtime.
*
* <p>
* This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an
* AuthException.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param clientSubject A Subject that represents the source of the service request, or null. It may be used by the
* method implementation as the source of Principals or credentials to be used to secure the request. If the Subject is
* not null, the method implementation may add additional Principals or credentials (pertaining to the source of the
* service request) to the Subject.
*
* @return An AuthStatus object representing the completion status of the processing performed by the method. The
* AuthStatus values that may be returned by this method are defined as follows:
* <ul>
* <li>AuthStatus.SUCCESS when the application request message was successfully secured. The secured request message may
* be obtained by calling getRequestMessage on messageInfo.
*
* <li>AuthStatus.SEND_CONTINUE to indicate that the application request message (within messageInfo) was replaced with
* a security message that should elicit a security-specific response from the peer security system. This status value
* also indicates that the application message has not yet been secured.
*
* This status value serves to inform the calling runtime that (to successfully complete the message exchange) it will
* need to be capable of continuing the message dialog by conducting at least one additional request/response exchange
* after having received the security-specific response elicited by sending the security message.
*
* When this status value is returned, the corresponding invocation of <code>validateResponse</code> must be able to
* obtain the original application request message.
*
* <li>AuthStatus.FAILURE to indicate that a failure occured while securing the request message, and that an appropriate
* failure response message is available by calling getResponseMessage on messageInfo.
* </ul>
*
* @exception AuthException When the message processing failed without establishing a failure response message (in
* messageInfo).
*/
AuthStatus secureRequest(MessageInfo messageInfo, Subject clientSubject) throws AuthException;

/**
* Validate a received service response.
*
* <p>
* This method is called to transform the mechanism-specific response message acquired by calling getResponseMessage (on
* messageInfo) into the validated application message to be returned to the message processing runtime. If the response
* message is a (mechanism-specific) meta-message, the method implementation must attempt to transform the meta-message
* into the next mechanism-specific request message to be sent by the runtime.
*
* <p>
* This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an
* AuthException.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param clientSubject A Subject that represents the recipient of the service response, or null. It may be used by the
* method implementation as the source of Principals or credentials to be used to validate the response. If the Subject
* is not null, the method implementation may add additional Principals or credentials (pertaining to the recipient of
* the service request) to the Subject.
*
* @param serviceSubject A Subject that represents the source of the service response, or null. If the Subject is not
* null, the method implementation may add additional Principals or credentials (pertaining to the source of the service
* response) to the Subject.
*
* @return An AuthStatus object representing the completion status of the processing performed by the method. The
* AuthStatus values that may be returned by this method are defined as follows:
* <ul>
* <li>AuthStatus.SUCCESS when the application response message was successfully validated. The validated message is
* available by calling getResponseMessage on messageInfo.
*
* <li>AuthStatus.SEND_CONTINUE to indicate that response validation is incomplete, and that a continuation request was
* returned as the request message within messageInfo.
*
* This status value serves to inform the calling runtime that (to successfully complete the message exchange) it will
* need to be capable of continuing the message dialog by conducting at least one additional request/response exchange.
*
* <li>AuthStatus.FAILURE to indicate that validation of the response failed, and that a failure response message has
* been established in messageInfo.
* </ul>
*
* @exception AuthException When the message processing failed without establishing a failure response message (in
* messageInfo).
*/
AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException;
/**
* Validate a received service response.
*
* <p>
* This method is called to transform the mechanism-specific response message acquired by calling getResponseMessage (on
* messageInfo) into the validated application message to be returned to the message processing runtime. If the response
* message is a (mechanism-specific) meta-message, the method implementation must attempt to transform the meta-message
* into the next mechanism-specific request message to be sent by the runtime.
*
* <p>
* This method conveys the outcome of its message processing either by returning an AuthStatus value or by throwing an
* AuthException.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param clientSubject A Subject that represents the recipient of the service response, or null. It may be used by the
* method implementation as the source of Principals or credentials to be used to validate the response. If the Subject
* is not null, the method implementation may add additional Principals or credentials (pertaining to the recipient of
* the service request) to the Subject.
*
* @param serviceSubject A Subject that represents the source of the service response, or null. If the Subject is not
* null, the method implementation may add additional Principals or credentials (pertaining to the source of the service
* response) to the Subject.
*
* @return An AuthStatus object representing the completion status of the processing performed by the method. The
* AuthStatus values that may be returned by this method are defined as follows:
* <ul>
* <li>AuthStatus.SUCCESS when the application response message was successfully validated. The validated message is
* available by calling getResponseMessage on messageInfo.
*
* <li>AuthStatus.SEND_CONTINUE to indicate that response validation is incomplete, and that a continuation request was
* returned as the request message within messageInfo.
*
* This status value serves to inform the calling runtime that (to successfully complete the message exchange) it will
* need to be capable of continuing the message dialog by conducting at least one additional request/response exchange.
*
* <li>AuthStatus.FAILURE to indicate that validation of the response failed, and that a failure response message has
* been established in messageInfo.
* </ul>
*
* @exception AuthException When the message processing failed without establishing a failure response message (in
* messageInfo).
*/
AuthStatus validateResponse(MessageInfo messageInfo, Subject clientSubject, Subject serviceSubject) throws AuthException;

/**
* Remove implementation specific principals and credentials from the subject.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param subject The Subject instance from which the Principals and credentials are to be removed.
*
* @exception AuthException If an error occurs during the Subject processing.
*/
void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException;
/**
* Remove implementation specific principals and credentials from the subject.
*
* @param messageInfo A contextual object that encapsulates the client request and server response objects, and that may
* be used to save state across a sequence of calls made to the methods of this interface for the purpose of completing
* a secure message exchange.
*
* @param subject The Subject instance from which the Principals and credentials are to be removed.
*
* @exception AuthException If an error occurs during the Subject processing.
*/
void cleanSubject(MessageInfo messageInfo, Subject subject) throws AuthException;
}

0 comments on commit 5b44640

Please sign in to comment.