%Net.HttpAuthentication
class %Net.HttpAuthentication extends %Library.RegisteredObject
This class implements various utility methods for HTTP authentication.It supports both proxy server authentication and target server authentication.
Property Inventory
- Authorization
- CurrentScheme
- Errors
- HttpRequest
- InitiateAuthentication
- IsProxy
- MaxDepth
- Password
- Schemes
- Server
- Username
Method Inventory
Properties
property Authorization as %String [ Calculated ];
The relevant authorization header of the associated HttpRequest.
Authorization - Target server
Proxy-Authorization - Proxy server
Property methods: AuthorizationDisplayToLogical(), AuthorizationIsValid(), AuthorizationLogicalToDisplay(), AuthorizationLogicalToOdbc(), AuthorizationNormalize()
property CurrentScheme as %String;
The authentication scheme that was used to do the most recent authentication.
Property methods: CurrentSchemeDisplayToLogical(), CurrentSchemeGet(), CurrentSchemeIsValid(), CurrentSchemeLogicalToDisplay(), CurrentSchemeLogicalToOdbc(), CurrentSchemeNormalize(), CurrentSchemeSet()
property Errors as %List;
The list of authentication related errors.
Property methods: ErrorsGet(), ErrorsIsValid(), ErrorsLogicalToOdbc(), ErrorsOdbcToLogical(), ErrorsSet()
property HttpRequest as %Net.HttpRequest;
The %Net.HttpRequest instance that is associated with this authentication.
Property methods: HttpRequestGet(), HttpRequestGetSwizzled(), HttpRequestIsValid(), HttpRequestNewObject(), HttpRequestSet()
property InitiateAuthentication as %String [ InitialExpression = "Basic" ];
Property methods: InitiateAuthenticationDisplayToLogical(), InitiateAuthenticationGet(), InitiateAuthenticationIsValid(), InitiateAuthenticationLogicalToDisplay(), InitiateAuthenticationLogicalToOdbc(), InitiateAuthenticationNormalize(), InitiateAuthenticationSet()
property IsProxy as %Boolean [ InitialExpression = 0 ];
Whether it is authenticating with an HTTP target server or proxy server.
0 - Target server
1 - Proxy server
Property methods: IsProxyDisplayToLogical(), IsProxyGet(), IsProxyIsValid(), IsProxyLogicalToDisplay(), IsProxyNormalize(), IsProxySet()
property MaxDepth as %Integer [ InitialExpression = 6 ];
The maximum of authentication round-trips
Property methods: MaxDepthDisplayToLogical(), MaxDepthGet(), MaxDepthIsValid(), MaxDepthLogicalToDisplay(), MaxDepthNormalize(), MaxDepthSet()
property Password as %String;
Password that is used for Basic authentication.
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property Schemes as %String [ InitialExpression = "Negotiate,NTLM,Basic" ];
The list of supported authentication schemes
Property methods: SchemesDisplayToLogical(), SchemesGet(), SchemesIsValid(), SchemesLogicalToDisplay(), SchemesLogicalToOdbc(), SchemesNormalize(), SchemesSet()
property Server as %String [ Calculated ];
The server to authenticate with
Property methods: ServerDisplayToLogical(), ServerIsValid(), ServerLogicalToDisplay(), ServerLogicalToOdbc(), ServerNormalize()
property Username as %Username;
Username that is used for Basic authentication.
Property methods: UsernameDisplayToLogical(), UsernameGet(), UsernameIsValid(), UsernameLogicalToDisplay(), UsernameLogicalToOdbc(), UsernameNormalize(), UsernameSet()
Methods
method CreateInitialHeader() as %Status
Create the initial Authorization header if requested and not manually created.
If InitiateAuthentication="basic" (the default), then skip initiating authentication unless Username specified.
method HasHandle() as %Boolean
Return true if there is an authentication handle;
return false otherwise
method ProcessHttpResponse(Output httpResponse As %Net.HttpResponse, type As %String, location As %String, test As %Integer = 0) as %Status
Check if an Authorization header needs to be created in repsonse to an HTTP response header.
WWW-Authenticate is for target server authorization, and
Proxy-Authenticate is for proxy server authorization.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()