Interface AuthProvider
- All Known Implementing Classes:
SamlAuthProvider
,ShiroAuthProvider
public interface AuthProvider
An interface which configures the authentication layer for the Central Dogma server.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
A base path of the built-in web app.static final String
A path which provides a built-in HTML login form to a user.static final String
A path which provides a built-in HTML logout page to a user.A set ofRoute
s which handles a login request.static final String
A login page path for the web console.A set ofRoute
s which handles a logout request.static final String
A logout page path for the web console. -
Method Summary
Modifier and TypeMethodDescriptiondefault HttpService
Returns aService
which handles a login request sent from the built-in web login page or somewhere implemented by anAuthProvider
.default HttpService
Returns aService
which handles a logout request sent from the built-in web logout page or somewhere implemented by anAuthProvider
.default Iterable
<HttpServiceWithRoutes> Returns additionalService
s which are required for working thisAuthProvider
well.default HttpService
Returns aService
which handles a login request from a web browser.default HttpService
Returns aService
which handles a logout request from a web browser.
-
Field Details
-
LOGIN_PATH
A login page path for the web console. If a user, who has not logged into the web console yet, opens the web console, the web browser would bring the user to the login page.- See Also:
-
LOGOUT_PATH
A logout page path for the web console. If a user clicks the logout button on the navigation bar, the web browser would bring the user to the logout page.- See Also:
-
BUILTIN_WEB_BASE_PATH
A base path of the built-in web app.- See Also:
-
BUILTIN_WEB_LOGIN_PATH
A path which provides a built-in HTML login form to a user.- See Also:
-
BUILTIN_WEB_LOGOUT_PATH
A path which provides a built-in HTML logout page to a user.- See Also:
-
LOGIN_API_ROUTES
A set ofRoute
s which handles a login request. It is necessary only if an authentication protocol requires a login feature provided by the server. -
LOGOUT_API_ROUTES
A set ofRoute
s which handles a logout request. It is necessary only if an authentication protocol requires a logout feature provided by the server.
-
-
Method Details
-
webLoginService
Returns aService
which handles a login request from a web browser. By default, the browser would bring a user to the built-in web login page served on "/web/auth/login". -
webLogoutService
Returns aService
which handles a logout request from a web browser. By default, the browser would bring a user to the built-in web logout page served on "/web/auth/logout". -
loginApiService
Returns aService
which handles a login request sent from the built-in web login page or somewhere implemented by anAuthProvider
. This service would be added to the server withLOGIN_API_ROUTES
only if it is provided. -
logoutApiService
Returns aService
which handles a logout request sent from the built-in web logout page or somewhere implemented by anAuthProvider
. This service would be added to the server withLOGOUT_API_ROUTES
. If it is not provided, a default service would be added because the web console provides a logout button on the navigation bar by default. -
moreServices
Returns additionalService
s which are required for working thisAuthProvider
well.
-