Package wt.httpgw

Class HTTPLogin

java.lang.Object
wt.httpgw.HTTPLogin
All Implemented Interfaces:
Externalizable, Serializable, MethodAuthenticator
public final class HTTPLogin extends Object implements MethodAuthenticator, Externalizable
This is a bootstrapping authenticator used if server is the willing to accept user names as authenticated by the HTTP server. This is the "normal" default authenticator for remote Java RMI clients.

By default this authenticator uses a URL based on the value of the wt.httpgw.url.authenticated WTProperties entry. This is appropriate for interactive, attended clients.

For non-interactive, unattended clients, this may be inappropriate, however. In particular, if the site is using form-based authentication an unattended client may not be able to satisfy the authentication requirement, e.g. in case a SecurId token is a required authentication field, or the authentication may time out after a period of inactivity.

This class allows one to work around this issue via several WTProperties entries, e.g. for a Java application that was originally intended for interactive, attended use but is does not require interaction and now is to be used in an unattended environment.

  • wt.httpgw.HTTPLogin.enableAuthPrefix - If set to "true", then this authenticator inserts the value of the wt.httpgw.HTTPLogin.authPrefix property into the value of wt.httpgw.url.authenticated right after the web application name prior to using it, e.g. http://yourHostAndPort/yourWebApp/prefix/... Defaults to "false".
  • wt.httpgw.HTTPLogin.authPrefix - The prefix used when wt.httpgw.HTTPLogin.enableAuthPrefix is "true". Defaults to "protocolAuth".
  • wt.httpgw.HTTPLogin.addTrustedAuthParam - If set to "true", then the pre-specified user id is included in the URL via a wt.effectiveUid query parameter. This is useful in conjunction with a prefix of "trustedAuth" and use of TrustedAuthFilter. Defaults to "false". Ignored when wt.httpgw.HTTPLogin.enableAuthPrefix is not "true". The user may be pre-specified via RemoteMethodServer.setUserName(java.lang.String) or via the com.ptc.net.auth.user property.
Note that these properties are described here rather than in properties.html as none of these are intended to be specified via wt.properties, but rather will either be specified as system properties or via command-line arguments read via WTContext.init(java.lang.String[]).

Supported API: true
Extendable: false
See Also:

  • Constructor Details

    • HTTPLogin

      public HTTPLogin()
      Supported API: true

    • HTTPLogin

      public HTTPLogin(String sessionId)
      Supported API: true