CredentialExitResult.java interface

CredentialExitResult.java

/*
 *   Licensed Materials - Property of IBM
 *
 *   "Restricted Materials of IBM"
 *
 *   5724-H72
 * 
 *    Copyright IBM Corp. 2008, 2025. All Rights Reserved.
 * 
 *   US Government Users Restricted Rights - Use, duplication or
 *   disclosure restricted by GSA ADP Schedule Contract with
 *   IBM Corp.
 */

package com.ibm.wmqfte.exitroutine.api;

/**
 * The result of invoking a Credential mapMQUserId exit method.  It is composed of a result
 * code, which determines whether the mapping of the user id was successful, and an optional 
 * Credentials object if the mapping is successful.
 */
public class CredentialExitResult {

	private final CredentialExitResultCode resultCode;
	private final Credentials credentials;
	
	/**
	 * Constructor.  Creates a credential exit result object with a specified result
	 * code and optionally credentials.
	 * 
	 * @param resultCode 
	 *            The result code to associate with the exit result being created.
	 *            
	 * @param credentials
	 *            The credentials to associate with the exit result being created.
	 *            A value of <code>null</code> can be specified to indicate no
	 *            credentials. If the resultCode is USER_SUCCESSFULLY_MAPPED the
	 *            credentials must be set to a non-null value,
	 */
	public CredentialExitResult(CredentialExitResultCode resultCode, Credentials credentials) {
		this.resultCode = resultCode;
		this.credentials = credentials;
	}
	

	/**
	 * Returns the result code associated with this credential exit result 
	 *
	 * @return    the result code associated with this exit result.
	 */
	public CredentialExitResultCode getResultCode() {
		return resultCode;
	}
	
	/**
	 * Returns the credentials associated with this credential exit result 
	 *
	 * @return    the explanation associated with this credential exit result.
	 */
	public Credentials getCredentials() {
		return credentials;
	}
}