public interface SessionStrategy
Session
instances. It is not expected that
most consumers will provide alternate session strategy implementations, but if required, this allows customization of
Session
lifecycles.
Note: if a session timeout occurs or the session is no longer available, a org.springframework.remoting.RemoteAccessException will be thrown on any API service method call.
Modifier and Type | Method and Description |
---|---|
Session |
logon(URL url,
String userId,
byte[] password)
Create an authenticated
Session object to allow interaction with the server. |
Session |
logon(URL url,
String userId,
byte[] password,
ProxyInfo proxyInfo)
Create an authenticated
Session object to allow interaction with the server. |
Session logon(URL url, String userId, byte[] password) throws AuthenticationException
Session
object to allow interaction with the server. This method uses the
specified server URL and credentials when establishing the connection.
The password supplied here can be clear text or an encrypted password that was encrypted using
UserService.encryptPassword(byte[])
. Only the API supports encrypted
passwords. The encrypted password should not be used to log on to the system interactively.
url
- the url of the server hosting the application instance.userId
- the user ID of the user who is creating the session.password
- the password of the user who is creating the session.AuthenticationException
- thrown if the credentials were incorrect.Session logon(URL url, String userId, byte[] password, ProxyInfo proxyInfo) throws AuthenticationException
Session
object to allow interaction with the server. This method uses the
specified server URL, credentials and proxy server information when establishing the connection. This method
should only be used when a proxy server is required to access the specified server URL.
The password supplied here can be clear text or an encrypted password that was encrypted using
UserService.encryptPassword(byte[])
. Only the API supports encrypted
passwords. The encrypted password should not be used to log on to the system interactively.
url
- the url of the server hosting the application instance.userId
- the user ID of the user who is creating the session.password
- the password of the user who is creating the session.proxyInfo
- the proxy server information and proxy credentials (if required) to access the server.AuthenticationException
- thrown if the credentials were incorrect.Copyright (c) 2019, SAS Institute Inc., Cary, NC, USA