Module jakarta.security.auth.message

Package jakarta.security.auth.message.callback

Class SecretKeyCallback.AliasRequest

java.lang.Object

jakarta.security.auth.message.callback.SecretKeyCallback.AliasRequest

All Implemented Interfaces:

SecretKeyCallback.Request

Enclosing class:

SecretKeyCallback

public static class SecretKeyCallback.AliasRequest
extends Object
implements SecretKeyCallback.Request

Request type for secret keys that are identified using an alias.

Constructor Summary

Constructors

Constructor	Description
AliasRequest(String alias)	Construct an AliasRequest with an alias.

Method Summary

Modifier and Type	Method	Description
String	getAlias()	Get the alias.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

AliasRequest

public AliasRequest(String alias)

Construct an AliasRequest with an alias.

The alias is used to directly identify the secret key to be returned.

If the alias is null, the handler of the callback relies on its own default.

Parameters:

alias - Name identifier for the secret key, or null.

Method Details

getAlias

public String getAlias()

Get the alias.

Returns:

The alias, or null.