Update the description for loginPageURL

This commit is contained in:
Terry W Brady
2018-01-24 10:22:56 -08:00
parent 80f3df4740
commit 96bb5eeca7
2 changed files with 9 additions and 3 deletions

View File

@@ -200,11 +200,16 @@ public interface AuthenticationMethod {
throws SQLException;
/**
* Get login page to which to redirect.
* Get an external login page to which to redirect.
*
* Returns URL (as string) to which to redirect to obtain
* credentials (either password prompt or e.g. HTTPS port for client
* cert.); null means no redirect.
*
* Note: Starting with DSpace 7, session logins will be managed through the REST
* API. Therefore, only authn providers with external login pages (such as Shibboleth)
* should return a login page.
*
* @param context
* DSpace context, will be modified (ePerson set) upon success.
*

View File

@@ -700,8 +700,9 @@ public class LDAPAuthentication
}
/*
* Returns URL to which to redirect to obtain credentials (either password
* prompt or e.g. HTTPS port for client cert.); null means no redirect.
* Returns the URL of an external login page which is not applicable for this authn method.
*
* Note: Prior to DSpace 7, this method return the page of login servlet.
*
* @param context
* DSpace context, will be modified (ePerson set) upon success.