EnsLib.Siebel.HTTPOutboundAdapter
class EnsLib.Siebel.HTTPOutboundAdapter extends EnsLib.HTTP.OutboundAdapter
A subclass that logs in to Siebel. It has a "virtual" StayConnected mode, i.e the HTTP TCP socket is not persistent but a Session cookie maintains state.Property Inventory
Method Inventory
Parameters
parameter SETTINGS = SWEExtSource,SWECredentials,UseCookies,HttpHeaderProps;
These are the production settings for this object
Properties
property %SWECredentialsObj as Ens.Config.Credentials;
This is the credentials object containing the values to be used to access the datasouce
Property methods: %SWECredentialsObjGet(), %SWECredentialsObjGetObject(), %SWECredentialsObjGetObjectId(), %SWECredentialsObjGetSwizzled(), %SWECredentialsObjIsValid(), %SWECredentialsObjNewObject(), %SWECredentialsObjSet(), %SWECredentialsObjSetObject(), %SWECredentialsObjSetObjectId(), %SWECredentialsObjUnSwizzle()
property HttpHeaderProps as %String;
A list of properties to set from HTTP headers, in the form: pkg.class.prop=hdrname,pkg.class.prop=hdrname,...
Property methods: HttpHeaderPropsDisplayToLogical(), HttpHeaderPropsGet(), HttpHeaderPropsIsValid(), HttpHeaderPropsLogicalToDisplay(), HttpHeaderPropsLogicalToOdbc(), HttpHeaderPropsNormalize(), HttpHeaderPropsSet()
property SWECredentials as %String;
This is the ID name of the set of credentials values to be used to log in to Siebel Workflow Engine (SWE)
Property methods: SWECredentialsDisplayToLogical(), SWECredentialsGet(), SWECredentialsIsValid(), SWECredentialsLogicalToDisplay(), SWECredentialsLogicalToOdbc(), SWECredentialsNormalize()
property SWEExtSource as %String;
Tells the Siebel Server the name of our system that's calling in.
Property methods: SWEExtSourceDisplayToLogical(), SWEExtSourceGet(), SWEExtSourceIsValid(), SWEExtSourceLogicalToDisplay(), SWEExtSourceLogicalToOdbc(), SWEExtSourceNormalize(), SWEExtSourceSet()
property UseCookies as %Boolean [ InitialExpression = 1 ];
If non-zero, stay logged on to the remote system between handling Requests
Property methods: UseCookiesDisplayToLogical(), UseCookiesGet(), UseCookiesIsValid(), UseCookiesLogicalToDisplay(), UseCookiesNormalize(), UseCookiesSet()
property cookie as %String;
Property methods: cookieDisplayToLogical(), cookieGet(), cookieIsValid(), cookieLogicalToDisplay(), cookieLogicalToOdbc(), cookieNormalize(), cookieSet()
property loggedIn as %Boolean [ InitialExpression = 0 ];
Property methods: loggedInDisplayToLogical(), loggedInGet(), loggedInIsValid(), loggedInLogicalToDisplay(), loggedInNormalize(), loggedInSet()
Methods
method Execute(pRequest As Ens.Request, Output pResponse As Ens.Response) as %Status
method Login() as %Status
method Logoff() as %Status
method OnInit() as %Status
Inherited description: This user callback method is called just after %OnNew()
method OnTearDown() as %Status
Inherited description: This user callback method is called just before %OnClose()
Inherited Members
Inherited Properties
- %Cookies
- %CredentialsObj
- %WarnedLatest
- %chunkedWriter
- %extraHeaders
- %proxyAuthorization
- BusinessHost
- ChunkSize
- Chunked
- ClearCachedResponseCookies
- ConnectTimeout
- Credentials
- ExtraHeaders
- HTTPPort
- HTTPServer
- KeepaliveInterval
- LocalInterface
- OAuth2AccessTokenPlacement
- OAuth2ApplicationName
- OAuth2AuthProperties
- OAuth2AuthorizationWorkFlowRole
- OAuth2CallBackHandler
- OAuth2GrantType
- OAuth2GrantTypeSpecific
- OAuth2JWTSubject
- OAuth2Scope
- OAuth2SessionId
- ProvideMetricsForSAM
- ProxyAuthorization
- ProxyHTTPS
- ProxyHttpTunnel
- ProxyPort
- ProxyServer
- RegistryID
- ResponseTimeout
- SAMDefinitionClass
- SAMDefinitionXData
- SSLCheckServerIdentity
- SSLConfig
- SkipBodyAttrs
- URL
- WriteTimeout
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()
- AssignOneSetting()
- ClearAllAppData()
- ClearRuntimeAppData()
- ClearStaticAppData()
- CredentialsSet()
- Delete()
- DeleteCookie()
- DeleteCookies()
- DeleteFormDataArray()
- DeleteURL()
- EnumerateSettingsClose()
- EnumerateSettingsExecute()
- EnumerateSettingsFetch()
- Get()
- GetFormDataArray()
- GetSettings()
- GetURL()
- OAuth2CallBackHandlerSet()
- OAuth2GrantTypeSpecificGet()
- OAuth2SessionIdGet()
- OnExitSendData()
- OnKeepalive()
- Patch()
- PatchFormDataArray()
- PatchURL()
- Post()
- PostFormDataArray()
- PostURL()
- Put()
- PutFormDataArray()
- PutURL()
- SendFormData()
- SendFormDataArray()
- SendFormDataURL()