Sessions Microservice
This is user sessions microservice from Pip.Services library.
It opens and closes user sessions and stores sessiond data.
The microservice currently supports the following deployment options:
- Deployment platforms: Standalone Process, Seneca
- External APIs: HTTP/REST, Seneca
- Persistence: Flat Files, MongoDB
This microservice has no dependencies on other microservices.
Quick Links:
Contract
Logical contract of the microservice is presented below. For physical implementation (HTTP/REST, Thrift, Seneca, Lambda, etc.),
please, refer to documentation of the specific protocol.
class SessionV1 implements IStringIdentifiable {
public id: string;
public user_id: string;
public user_name: string;
public active: boolean;
public open_time: Date;
public close_time: Date;
public request_time: Date;
public address: string;
public client: string;
public user: any;
public data: any;
}
interface ISessionsV1 {
getSessions(correlationId: string, filter: FilterParams, paging: PagingParams): Promise<DataPage<SessionV1>>;
getSessionById(correlationId: string, sessionId: string): Promise<SessionV1>;
openSession(correlationId: string, user_id: string, user_name: string,
address: string, client: string, user: any, data: any): Promise<SessionV1>;
storeSessionData(correlationId: string, sessionId: string, data: any): Promise<SessionV1>;
closeSession(correlationId: string, sessionId: string): Promise<SessionV1>;
deleteSessionById(correlationId: string, sessionId: string): Promise<SessionV1>;
}
Download
Right now the only way to get the microservice is to check it out directly from github repository
git clone git@github.com:pip-services-users2/service-sessions-node.git
Pip.Service team is working to implement packaging and make stable releases available for your
as zip downloadable archieves.
Run
Add config.yml file to the root of the microservice folder and set configuration parameters.
As the starting point you can use example configuration from config.example.yml file.
Example of microservice configuration
---
- descriptor: "service-commons:logger:console:default:1.0"
level: "trace"
- descriptor: "service-sessions:persistence:file:default:1.0"
path: "./data/sessions.json"
- descriptor: "service-sessions:controller:default:default:1.0"
- descriptor: "service-sessions:service:commandable-http:default:1.0"
connection:
protocol: "http"
host: "0.0.0.0"
port: 8080
For more information on the microservice configuration see Configuration Guide.
Start the microservice using the command:
node run
Use
The easiest way to work with the microservice is to use client SDK.
The complete list of available client SDKs for different languages is listed in the Quick Links
If you use Node.js then you should add dependency to the client SDK into package.json file of your project
{
...
"dependencies": {
....
"client-sessions-node": "^1.0.*",
...
}
}
Inside your code get the reference to the client SDK
var sdk = new require('client-sessions-node');
Define client configuration parameters that match configuration of the microservice external API
var config = {
connection: {
protocol: 'http',
host: 'localhost',
port: 8080
}
};
Instantiate the client and open connection to the microservice
var client = sdk.SessionsHttpClientV1(config);
try {
await client.open(null);
} catch(err) {
console.error('Connection to the microservice failed');
console.error(err);
}
Now the client is ready to perform operations
let session = await client.openSession(
null,
'123',
'Test User'
'192.168.1.1',
'Test Client',
null
);
let sessions = await client.getSessions(
null,
null
);
Acknowledgements
This microservice was created and currently maintained by Sergey Seroukhov.