ProtocolBridgeCredentialExit2.java
/*
* Licensed Materials - Property of IBM
*
* “Restricted Materials of IBM”
*
* 5724-H72
*
* Copyright IBM Corp. 2011, 2024. 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;
/**
* An interface that is implemented by classes that are invoked as part of user
* exit routine processing. This interface defines methods that are invoked by a
* protocol bridge agent to map the MQ user ID of the transfer to credentials
* used to access a specified protocol bridge server. There will be one instance
* of each implementation class for each protocol bridge agent. The methods can
* be called from different threads so the methods must be synchronized.
*/
public interface ProtocolBridgeCredentialExit2 extends
ProtocolBridgeCredentialExit {
/**
* Invoked once for each transfer to map the MQ user ID in the transfer
* message to the credentials used to access a specified protocol server.
*
* @param endPoint
* Information that describes the protocol server to be accessed.
* @param mqUserId
* The MQ user ID from which to map the credentials used to
* access the protocol server.
* @return A {@link CredentialExitResult) instance that contains the result
* of the map and the credentials to use to access the protocol
* server.
*/
public CredentialExitResult mapMQUserId(
final ProtocolServerEndPoint endPoint, final String mqUserId);
}