A Client defines how a Session "connects" to the OpenPTK server, through the use of an Authenticator. It also defines what Contexts are allowed to be used. A Client needs to have at least one Authenticator and one Context.
Syntax
<Client id="..." secret="..."> <Properties> <Property name="client.description" value="My Application" />
</Properties> <Authenticators> <Authenticator .../>
</Authenticators> <Contexts default="..."> <Context ... /> </Contexts> </Client>Arguments | Name | Required | Description | Example |
|---|
| id | Yes | A unique id for the Client. This is as part of defining a Client | id="myapp"
| | secret | No | The value of a shared secret known by the deployed application and the OpenPTK Server. The client application must be configured with the same value when an Authenticator needs to validate the client. The value can be any String, to should be kept private and only given to the developer / administrator of the client application. The client will encrypt this value before it sends it to the Server, during the authentication process.
The "secret" argument is typically not used when the Client will access the OpenPTK Server anonymously (using the Anonymous Authenticator) | secret="OkBh9iciqyMJufiLwwNR8CBR" |
| Be Careful: | If a Property has the same name as a Property from the higher-level Element (Clients) ... it will be replaced with the Property value at this level.
|
Properties| Name | Required | Description | Example |
|---|
| client.description | No | A descriptive name for the Client | value="My Application" |
| 