TROWebBrokerServer

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

property AccessControlMaxAge: Integer read write

---

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: Boolean read write

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the server properties.

procedure CheckProperties

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse: string read write

---

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

• Message specifies the message format to be used for this dispatcher.
• Name specifies the name, or possibly the URL for the dispatcher.

In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

Processes CORS requests.

function DoCORSSupport(const aRequest: IUnknown; const aResponse: IROHTTPResponse): Boolean

Parameters:

• aRequest: Request
• aResponse: Response

---

Performs GZIP decoding

procedure DoDecodeStream(const aSource: TStream; out aDest: TStream)

Parameters:

• aSource: Source
• aDest: Destination

---

Performs GZIP encoding

procedure DoEncodeStream(const aSource: TStream)

Parameters:

• aSource: Source

---

procedure DoGetCustomClientAccessPolicy(var aPolicyContent: string)

Parameters:

• aPolicyContent:

---

Generates documentation if correspondent request is detected

function DoProcessDocs(const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aResponseStream: TStream; const aRoot: string; const aSub: string): Boolean

Parameters:

• aRequest: Request
• aResponse: Response
• aResponseStream: Response stream
• aRoot: Root (part before ?)
• aSub: Query string (part after ?)

---

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

List of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is TROJavaScriptHttpDispatcher dispatcher.

property ExtendedDispatchers: TROExtendedHTTPDispatcherList read

---

IROHTTPRequest.AuthPassword property get accessor.

function GetAuthPassword: UnicodeString

---

Gets the user name if authentication is used.

function GetAuthUsername: UnicodeString

---

Returns CA certificate

function GetCACertificate: string

---

IROHTTPTransportEx.CanUseContentEncoding property get accessor.

function GetCanUseContentEncoding: Boolean

---

IROHTTPTransport.ContentType property get accessor.

function GetContentType: string

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

IROHTTPTransport.Headers property get accessor.

function GetHeaders(const aName: string): string

Parameters:

• aName: The name of the header field to get value of.

---

IROHTTPTransport.Location property get accessor.

function GetLocation: string

---

function GetMethod: string

---

Gets the value of the path information of the URL specified in the HTTP request message.

function GetPathInfo: string

---

Returns the request query parameter with the specified name.

function GetQueryParameter(const aName: string): string

Parameters:

• aName: Name of parameter

---

Returns the corresponding part of the HTTP query string.

function GetQueryString: string

---

function GetQueryString(aValue: string): string

Parameters:

• aValue:

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns rstHTTP. This property is used by the ZeroConf infrastructure.

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

Gets the User-Agent string.

function GetUserAgent: string

---

IROHTTPRequest.UsesAuthentication property get accessor.

function GetUsesAuthentication: Boolean

---

Processes Extended Dispatcher requests.

function HandleExtendedDispatchers(const aRoot: string; const aTransport: IROHTTPTransport; const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aRequestData: TStream; const aResponseData: TStream): Boolean

Parameters:

• aRoot: Path Info
• aTransport: Transport channel
• aRequest: Request
• aResponse: Response
• aRequestData: Request stream
• aResponseData: Response stream

---

Realm for http authentication.

property HTTPAuthenticationRealm: string read write

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

The minimal size when GZIP encoding will be used (default is 4096 bytes)

property MinSizeForGzipEncoding: Integer read write

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Fired after stream was encrypted

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate:  procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

---

Fired before stream will be decrypted

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate:  procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

---

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnCustomResponseEvent: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnCustomResponseEvent(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

This event is fired when SendClientAccessPolicyXml is set to captCustom. Allows more precise management of client access policies.

The handler of this event generates a valid ClientAccessPolicy.xml and puts it to the aPolicyContent parameter.

property OnGetCustomClientAccessPolicy: TROCustomClientAccessPolicyMethod read write
delegate:  procedure OnGetCustomClientAccessPolicy(aSender: TObject; var aPolicyContent: ROUTF8String)

---

property OnGetRODLReader: TROGetRODLReader read write

---

Fires if RequireHTTPAuthentication is set and correspondent fields are present in client request.

property OnHTTPAuthentication: TROHTTPAuthentication read write
delegate:  procedure OnHTTPAuthentication(const aRequest: IROHTTPRequest; const aUserName: string; const aPassword: string; var aHandled: Boolean)

---

Fires after request was processed

property OnHTTPRequestDone: TROHTTPRequestDone read write
delegate:  procedure OnHTTPRequestDone(const aResponse: IROHTTPResponse; const aResponseStream: TStream)

---

Fires after a stream with a request message has been received from the client. The event handler can inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReadFromStream: TStreamOperation read write
delegate:  procedure OnReadFromStream(aStream: TStream)

---

This event is fired when server channel receives OPTIONS request. This event allows more precise management of cross-origin client access policies.

property OnSendCrossOriginHeader: TROHTTPSendCrossOriginHeader read write
delegate:  procedure OnSendCrossOriginHeader(var AllowedOrigin: string)

---

property OnSendCrossOriginHeaderEx: TROHTTPSendCrossOriginHeaderEx read write
delegate:  function OnSendCrossOriginHeaderEx(var Cors: TROCorsStruct): Boolean

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnUnknownHTTPRequest: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnUnknownHTTPRequest(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate:  procedure OnWriteToStream(aStream: TStream)

---

Parses PathInfo and splits it to root and query

procedure ParsePathInfo(const aPathInfo: string; var aRoot: string; var aSub: string)

Parameters:

• aPathInfo: PathInfo
• aRoot: Root (part after ?)
• aSub: Query string (part after ?)

---

The network socket where the server will be listening

property Port: Integer read write

---

This is basically the core of the entire server channel. This method processes incoming HTTP requests and performs requested actions (service method call, RODL request etc).

procedure ProcessRequest(const aTransport: IROHTTPTransportEx; const aRequestStream: TStream; out aResponseStream: TStream; const aResponse: IROHTTPResponse)

Parameters:

• aTransport: Transport instance
• aRequestStream: Request stream
• aResponseStream: Response stream
• aResponse: Response

---

Register Extended HTTP Dispatcher

procedure Register(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

---

Used to inject IntOnBeforeDispatch method into client's request processing.

procedure ReplaceBeforeDispatch(aOwner: TComponent; aNewHandler: THTTPMethodEvent)

Parameters:

• aOwner: owner
• aNewHandler: handler

---

When the request is about to be dispatched provides access to the web request object that contains all client request information passed to the web server.

property Request: TWebRequest read

---

Actual implementation of the IROHTTPRequest.GetContentType method.

function Request_GetContentType: string

---

Allows to use HTTP Authentication.

property RequireHTTPAuthentication: Boolean read write

---

When the request is about to be dispatched provides access to the web response object that specifies the response to be passed back to the client.

property Response: TWebResponse read

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Gets or sets the intended server behavior when the ClientAccessPolicy.xml file (security policy file) is requested.

Possible values are:

• captAllowNone - All requests are denied.
• captAllowAll - All requests are allowed.
• captCustom - Custom request policy is applied. Custom security policy file is generated via the OnGetCustomClientAccessPolicy event handler.

property SendClientAccessPolicyXml: TROClientAccessPolicyType read write

---

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

property SendCrossOriginHeader: Boolean read write

---

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors), or a standard "200" message code (false).

Some proxy servers might perform special handling on 500 error messages that will prevent exception messages sent back as 500 to be recognized properly. If you are seeing this problem, try setting this property to false. If not, it is recommended to keep the default value.

property SendExceptionsAs500: Boolean read write

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Specifies whether the HTTP server will serve up a page with human-readable information about the server when being accessed from a web browser. This information page will contain details about the registered dispatchers and the documentation for the services.

property ServeInfoPage: Boolean read write

---

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

---

Allows to get/set Service Groups

property ServiceGroup: string read write

---

IROHTTPRequest.AuthPassword property set accessor.

procedure SetAuthPassword(const Value: UnicodeString)

Parameters:

• Value: password

---

Sets the user name if authentication is required.

procedure SetAuthUsername(const Value: UnicodeString)

Parameters:

• Value: user name

---

Sets the value of the path information of the URL specified in the HTTP request message.

procedure SetPathInfo(const aValue: string)

Parameters:

• aValue: value

---

Declares the User-Agent string. This string is sent for informational purposes only; you can set it to a custom value to detect and distinguish your client (as opposed to other client applications or web browsers accessing the server) in the server log files or the HTTP packet monitors.

procedure SetUserAgent(const aValue: string)

Parameters:

• aValue: user agent

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

---

Unregister Extended HTTP Dispatcher

procedure Unregister(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

 

property AccessControlMaxAge: Integer read write

---

Toggles whether the server ready to receive requests from clients. Depending on the server type, changing this property might open/close a network socket or otherwise toggle whether the server will process incoming requests.

property Active: Boolean read write

---

Holds the message that will be sent back to the client if it improperly "welcomes" the server.

property DefaultResponse: string read write

---

Specifies how incoming requests will be processed and dispatched. Depending on the server type, one or multiple dispatchers can be configured to receive messages from the client. Each dispatcher consists of a Message and an optional Name. Also, each dispatcher can be individually enabled or disabled. Each server must have at least one dispatcher configured, in order to be able to process messages.

=Essential Sub-Properties=

• Message specifies the message format to be used for this dispatcher.
• Name specifies the name, or possibly the URL for the dispatcher.

In HTTP based servers (such as the TROIndyHTTPServer, the Name will be appended as folder to the server URL allowing the server to make multiple dispatchers available at different URLs.

property Dispatchers: TROMessageDispatchers read write

---

This is DES based enscryption, it is obsolete because works only for Delphi. Use message envelope AES Encryption Envelope instead.

property Encryption: TROEncryption read write

---

List of extended dispatchers attached to the server channel instance.

Extended dispatchers are dispatchers that perform special tasks other than calling server services. A good example of an extended dispatcher is TROJavaScriptHttpDispatcher dispatcher.

property ExtendedDispatchers: TROExtendedHTTPDispatcherList read

---

Realm for http authentication.

property HTTPAuthenticationRealm: string read write

---

The minimal size when GZIP encoding will be used (default is 4096 bytes)

property MinSizeForGzipEncoding: Integer read write

---

property OnGetRODLReader: TROGetRODLReader read write

---

The network socket where the server will be listening

property Port: Integer read write

---

When the request is about to be dispatched provides access to the web request object that contains all client request information passed to the web server.

property Request: TWebRequest read

---

Allows to use HTTP Authentication.

property RequireHTTPAuthentication: Boolean read write

---

When the request is about to be dispatched provides access to the web response object that specifies the response to be passed back to the client.

property Response: TWebResponse read

---

Gets or sets the intended server behavior when the ClientAccessPolicy.xml file (security policy file) is requested.

Possible values are:

• captAllowNone - All requests are denied.
• captAllowAll - All requests are allowed.
• captCustom - Custom request policy is applied. Custom security policy file is generated via the OnGetCustomClientAccessPolicy event handler.

property SendClientAccessPolicyXml: TROClientAccessPolicyType read write

---

Gets or sets a flag indicating whether the server should handle the incoming CORS requests or ignore them.

property SendCrossOriginHeader: Boolean read write

---

If set to true, messages about exceptions occurred on the server will be sent with a HTTP Error 500 header set (standard HTTP header for internal server errors), or a standard "200" message code (false).

Some proxy servers might perform special handling on 500 error messages that will prevent exception messages sent back as 500 to be recognized properly. If you are seeing this problem, try setting this property to false. If not, it is recommended to keep the default value.

property SendExceptionsAs500: Boolean read write

---

Specifies whether the HTTP server will serve up a page with human-readable information about the server when being accessed from a web browser. This information page will contain details about the registered dispatchers and the documentation for the services.

property ServeInfoPage: Boolean read write

---

Specifies whether the server will make the contained RODL file available to clients (true, default) or not. Keep this property set to true if clients need to access the RODL (or WSDL), for example so that third parties (including Service Tester) can import services. Set it to false if you do not want to provide this information, for example for security reasons.

property ServeRodl: Boolean read write

---

Allows to get/set Service Groups

property ServiceGroup: string read write

 

Standard component constructor

constructor Create(aOwner: TComponent)

Parameters:

• aOwner: Owner

---

Copies the contents of another, similar object.

procedure Assign(Source: TPersistent)

Parameters:

• Source: Instance whose properties will be copied

---

Validates the server properties.

procedure CheckProperties

---

Decrypt stream

procedure DecryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Decrypt stream

procedure DecryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:

---

function DispatchMessage(const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

procedure DoBeforeDecryptEvent(aEncryptedStream: TStream)

Parameters:

• aEncryptedStream: Stream

---

Processes CORS requests.

function DoCORSSupport(const aRequest: IUnknown; const aResponse: IROHTTPResponse): Boolean

Parameters:

• aRequest: Request
• aResponse: Response

---

Performs GZIP decoding

procedure DoDecodeStream(const aSource: TStream; out aDest: TStream)

Parameters:

• aSource: Source
• aDest: Destination

---

Performs GZIP encoding

procedure DoEncodeStream(const aSource: TStream)

Parameters:

• aSource: Source

---

procedure DoGetCustomClientAccessPolicy(var aPolicyContent: string)

Parameters:

• aPolicyContent:

---

Generates documentation if correspondent request is detected

function DoProcessDocs(const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aResponseStream: TStream; const aRoot: string; const aSub: string): Boolean

Parameters:

• aRequest: Request
• aResponse: Response
• aResponseStream: Response stream
• aRoot: Root (part before ?)
• aSub: Query string (part after ?)

---

Encrypt stream

procedure EncryptStream(const Source: TStream; const Dest: TStream)

Parameters:

• Source: Source
• Dest: Destination

---

Encrypt stream

procedure EncryptStream(const Stream: TStream)

Parameters:

• Stream: Stream

---

IROHTTPRequest.AuthPassword property get accessor.

function GetAuthPassword: UnicodeString

---

Gets the user name if authentication is used.

function GetAuthUsername: UnicodeString

---

Returns CA certificate

function GetCACertificate: string

---

IROHTTPTransportEx.CanUseContentEncoding property get accessor.

function GetCanUseContentEncoding: Boolean

---

IROHTTPTransport.ContentType property get accessor.

function GetContentType: string

---

Returns TROMessageDispatchers class

function GetDispatchersClass: TROMessageDispatchersClass

---

IROHTTPTransport.Headers property get accessor.

function GetHeaders(const aName: string): string

Parameters:

• aName: The name of the header field to get value of.

---

IROHTTPTransport.Location property get accessor.

function GetLocation: string

---

function GetMethod: string

---

Gets the value of the path information of the URL specified in the HTTP request message.

function GetPathInfo: string

---

Returns the request query parameter with the specified name.

function GetQueryParameter(const aName: string): string

Parameters:

• aName: Name of parameter

---

Returns the corresponding part of the HTTP query string.

function GetQueryString: string

---

function GetQueryString(aValue: string): string

Parameters:

• aValue:

---

function GetRODLReader: TROCustomRODLReader

---

Returns SSL state

function GetSecure: Boolean

---

Returns rstHTTP. This property is used by the ZeroConf infrastructure.

function GetServerType: TROServerType

---

function GetServiceMetaData(aServiceName: string; aOptions: string; out aContentType: string): TStream

Parameters:

• aServiceName:
• aOptions:
• aContentType:

---

Returns itself.

function GetTransportObject: TObject

---

Gets the User-Agent string.

function GetUserAgent: string

---

IROHTTPRequest.UsesAuthentication property get accessor.

function GetUsesAuthentication: Boolean

---

Processes Extended Dispatcher requests.

function HandleExtendedDispatchers(const aRoot: string; const aTransport: IROHTTPTransport; const aRequest: IUnknown; const aResponse: IROHTTPResponse; const aRequestData: TStream; const aResponseData: TStream): Boolean

Parameters:

• aRoot: Path Info
• aTransport: Transport channel
• aRequest: Request
• aResponse: Response
• aRequestData: Request stream
• aResponseData: Response stream

---

function IntDispatchMessage(Dispatcher: TROMessageDispatcher; const aTransport: IROTransport; aRequestStream: TStream; aResponseStream: TStream; out oResponseOptions: TROResponseOptions): Boolean

Parameters:

• Dispatcher:
• aTransport:
• aRequestStream:
• aResponseStream:
• oResponseOptions:

---

Checks if encryption was used

function IsEncryptionUsed: Boolean

---

function IsServiceAllowed(Value: string): Boolean

Parameters:

• Value:

---

Checks state of stream

function IsStreamEncrypted(Source: TStream): Boolean

Parameters:

• Source: Stream

---

Forwards notification messages to all owned components.

procedure Notification(AComponent: TComponent; Operation: TOperation)

Parameters:

• AComponent: component
• Operation: operation

---

Parses PathInfo and splits it to root and query

procedure ParsePathInfo(const aPathInfo: string; var aRoot: string; var aSub: string)

Parameters:

• aPathInfo: PathInfo
• aRoot: Root (part after ?)
• aSub: Query string (part after ?)

---

This is basically the core of the entire server channel. This method processes incoming HTTP requests and performs requested actions (service method call, RODL request etc).

procedure ProcessRequest(const aTransport: IROHTTPTransportEx; const aRequestStream: TStream; out aResponseStream: TStream; const aResponse: IROHTTPResponse)

Parameters:

• aTransport: Transport instance
• aRequestStream: Request stream
• aResponseStream: Response stream
• aResponse: Response

---

Register Extended HTTP Dispatcher

procedure Register(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

---

Used to inject IntOnBeforeDispatch method into client's request processing.

procedure ReplaceBeforeDispatch(aOwner: TComponent; aNewHandler: THTTPMethodEvent)

Parameters:

• aOwner: owner
• aNewHandler: handler

---

Actual implementation of the IROHTTPRequest.GetContentType method.

function Request_GetContentType: string

---

Forwards notification messages to all owned components.

procedure ROFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure RORemoveFreeNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

Forwards notification messages to all owned components.

procedure SendRemoveNotification(aComponent: TComponent)

Parameters:

• aComponent: component

---

IROHTTPRequest.AuthPassword property set accessor.

procedure SetAuthPassword(const Value: UnicodeString)

Parameters:

• Value: password

---

Sets the user name if authentication is required.

procedure SetAuthUsername(const Value: UnicodeString)

Parameters:

• Value: user name

---

Sets the value of the path information of the URL specified in the HTTP request message.

procedure SetPathInfo(const aValue: string)

Parameters:

• aValue: value

---

Declares the User-Agent string. This string is sent for informational purposes only; you can set it to a custom value to detect and distinguish your client (as opposed to other client applications or web browsers accessing the server) in the server log files or the HTTP packet monitors.

procedure SetUserAgent(const aValue: string)

Parameters:

• aValue: user agent

---

Fires the OnReadFromStream event

procedure TriggerReadFromStream(aSource: TStream)

Parameters:

• aSource: stream

---

Fires the OnReadFromStream event

procedure TriggerWriteToStream(aDest: TStream)

Parameters:

• aDest: stream

---

Unregister Extended HTTP Dispatcher

procedure Unregister(aDispatcher: IROHTTPDispatcher)

Parameters:

• aDispatcher: Extended HTTP Dispatcher

 

Fired after stream was encrypted

property OnAfterEncrypt: TROBaseConnectionOperation read write
delegate:  procedure OnAfterEncrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires after the server has been activated.

property OnAfterServerActivate: TNotifyEvent read write

---

Fires after the server has been deactivated. You can use this event handler to perform any cleanup you might need after the server has stopped processing new requests.

property OnAfterServerDeactivate: TNotifyEvent read write

---

Fired before stream will be decrypted

property OnBeforeDecrypt: TROBaseConnectionOperation read write
delegate:  procedure OnBeforeDecrypt(Sender: TROBaseConnection; aEncryptedStream: TStream)

---

Fires just before the server is activated. You can use this event handler to perform any initialization you might need before the server starts processing new requests.

property OnBeforeServerActivate: TNotifyEvent read write

---

Fires just before the server is deactivated. You can use this event handler to perform any cleanup you might need before the server stops processing new requests.

property OnBeforeServerDeactivate: TNotifyEvent read write

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnCustomResponseEvent: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnCustomResponseEvent(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

This event is fired when SendClientAccessPolicyXml is set to captCustom. Allows more precise management of client access policies.

The handler of this event generates a valid ClientAccessPolicy.xml and puts it to the aPolicyContent parameter.

property OnGetCustomClientAccessPolicy: TROCustomClientAccessPolicyMethod read write
delegate:  procedure OnGetCustomClientAccessPolicy(aSender: TObject; var aPolicyContent: ROUTF8String)

---

Fires if RequireHTTPAuthentication is set and correspondent fields are present in client request.

property OnHTTPAuthentication: TROHTTPAuthentication read write
delegate:  procedure OnHTTPAuthentication(const aRequest: IROHTTPRequest; const aUserName: string; const aPassword: string; var aHandled: Boolean)

---

Fires after request was processed

property OnHTTPRequestDone: TROHTTPRequestDone read write
delegate:  procedure OnHTTPRequestDone(const aResponse: IROHTTPResponse; const aResponseStream: TStream)

---

Fires after a stream with a request message has been received from the client. The event handler can inspect and possibly modify the stream, before it continues to be processed by the higher levels of the Remoting SDK framework.

property OnReadFromStream: TStreamOperation read write
delegate:  procedure OnReadFromStream(aStream: TStream)

---

This event is fired when server channel receives OPTIONS request. This event allows more precise management of cross-origin client access policies.

property OnSendCrossOriginHeader: TROHTTPSendCrossOriginHeader read write
delegate:  procedure OnSendCrossOriginHeader(var AllowedOrigin: string)

---

property OnSendCrossOriginHeaderEx: TROHTTPSendCrossOriginHeaderEx read write
delegate:  function OnSendCrossOriginHeaderEx(var Cors: TROCorsStruct): Boolean

---

Allows to handle unknown requests, i.e. that aren't recognised by ProcessRequest

property OnUnknownHTTPRequest: TROHTTPGetCustomResponseEvent read write
delegate:  procedure OnUnknownHTTPRequest(const aTransport: IROHTTPTransport; const aRequestStream: TStream; const aResponseStream: TStream; const aResponse: IROHTTPResponse; var aHandled: Boolean)

---

Fires just before a stream with a response message is sent back to the client. The event handler can inspect and possibly modify the stream, before it continues to be sent off to the client.

property OnWriteToStream: TStreamOperation read write
delegate:  procedure OnWriteToStream(aStream: TStream)