aQute.openapi.security.api

Interface Authentication

public interface Authentication

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUser() The user name or null if set.
boolean	ignore() Some security providers can be ignored, they are just there to trace
boolean	isAuthenticated() Is the caller authenticated?
boolean	needsCredentials() Indicate if the caller could provide credentials
void	requestCredentials() Force the security provider to request the credentials

Method Detail

getUser

java.lang.String getUser()

The user name or null if set. This does not imply authentication

Returns:

the user name or null

needsCredentials

boolean needsCredentials()
                  throws java.lang.Exception

Indicate if the caller could provide credentials

Returns:

true if the caller needs to provide credentials

Throws:

java.lang.Exception

requestCredentials

void requestCredentials()
                 throws java.lang.Exception

Force the security provider to request the credentials

Throws:

java.lang.Exception

isAuthenticated

boolean isAuthenticated()
                 throws java.lang.Exception

Is the caller authenticated?

Returns:

true if the caller is authenticated

Throws:

java.lang.Exception

ignore

boolean ignore()

Some security providers can be ignored, they are just there to trace

Returns:

true if this authentication can be ignored