JGit 7.2.0.202503040940-r · org.eclipse.jgit.internal.transport.sshd.auth.AuthenticationHandler

An AuthenticationHandler encapsulates a possibly multi-step authentication protocol. Intended usage:

setParams(something);
start();
sendToken(getToken());
while (!isDone()) {
	setParams(receiveMessageAndExtractParams());
	process();
	Object t = getToken();
	if (t != null) {
		sendToken(t);
	}
}

An AuthenticationHandler may be stateful and therefore is a Closeable.

Method Summary

Modifier and Type	Method and Description
public void	close() Redeclares java.io.Closeable.close. Closes this stream and releases any system resources associated with it.
public TokenType	Returns: the token, or `null` if there is none getToken() Retrieves the last token generated.
public boolean	Returns: whether this authentication is done isDone() Tells whether is authentication mechanism is done (successfully or unsuccessfully).
public void	process() Produces the next authentication token, if any.
public void	setParams(ParameterType to set, may be `null` input) Sets the parameters for the next token generation via `start()` or `process()`.
public void	start() Produces the initial authentication token that can be then retrieved via `getToken()`.

Method Detail

close back to summary

close	back to summary
public void close() Redeclares java.io.Closeable.close. Doc from java.io.Closeable.close. Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect. As noted in `AutoCloseable#close()`, cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the `Closeable` as closed, prior to throwing the `IOException`. Annotations @Override

public void close()

Redeclares java.io.Closeable.close.

Doc from java.io.Closeable.close.

Closes this stream and releases any system resources associated with it. If the stream is already closed then invoking this method has no effect.

As noted in AutoCloseable#close(), cases where the close may fail require careful attention. It is strongly advised to relinquish the underlying resources and to internally mark the Closeable as closed, prior to throwing the IOException.

Annotations

@Override

getToken back to summary

getToken	back to summary
public TokenType getToken() throws Exception Retrieves the last token generated. Returns:TokenType the token, or `null` if there is none Exceptions Exception: if an error occurs

public TokenType getToken() throws Exception

Retrieves the last token generated.

Returns:TokenType

the token, or null if there is none

Exceptions

Exception:: if an error occurs

isDone	back to summary
public boolean isDone() Tells whether is authentication mechanism is done (successfully or unsuccessfully). Returns:boolean whether this authentication is done

isDone

back to summary

public boolean isDone()

Tells whether is authentication mechanism is done (successfully or unsuccessfully).

Returns:boolean: whether this authentication is done

process	back to summary
public void process() throws Exception Produces the next authentication token, if any. Exceptions Exception: if an error occurs

process

back to summary

public void process() throws Exception

Produces the next authentication token, if any.

Exceptions

Exception:: if an error occurs

setParams back to summary

setParams	back to summary
public void setParams(ParameterType input) Sets the parameters for the next token generation via `start()` or `process()`. Parameters input:ParameterType to set, may be `null`

public void setParams(ParameterType input)

Sets the parameters for the next token generation via start() or process().

Parameters

input:ParameterType: to set, may be null

start back to summary

start	back to summary
public void start() throws Exception Produces the initial authentication token that can be then retrieved via `getToken()`. Exceptions Exception: if an error occurs

public void start() throws Exception

Produces the initial authentication token that can be then retrieved via getToken().

Exceptions

Exception:: if an error occurs

public Interface AuthenticationHandler<ParameterType, TokenType>

Method Summary

Method Detail