Skip to content
This repository has been archived by the owner on Jun 26, 2020. It is now read-only.

symanto-research/Angular-SessionManagement

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 

Repository files navigation

Angular-SessionManagement

Installation

###Bower The easiest way to install the SessionManagement module is by including the bower package to your solution

bower install symanto-angular-sessionmanagement --save

Afterwards you just need to add the module and the required angular-local-storage module to your HTML file

<script src="bower_components/angular-local-storage/dist/angular-local-storage.min.js"></script>
<script src="bower_components/symanto-angular-sessionmanagement/SessionManagement.js"></script>

Configuration

You need to configure the SessionManagement module to let it fit to your needs. Beside that it beautifully integrates with other Symanto Angular modules like the LoadingIndicatorService.

The Session Management module uses cookies to save the access- and refresh tokens. These cookies are saved inside the browser's local storage. For this, we use the 3rd party angular-local-storage module. If you use bower, it comes automatically with the package and just have to be included. Otherwise you need to download and add it by yourself.

To add this module load them into your project and inject them into your root module. Here you can configure the SessionManagement by setting the parameters inside the run method.

angular.module("Application.Root", [
    "LocalStorageModule",
    "Symanto.SessionManagement",
    "Symanto.LoadingIndicator"
]).run(function(sessionManagementOptions, LoadingIndicatorService) {

    // REQUIRED CONFIGURATION
    // ----------------------
    // Define the login API endpoint
    sessionManagementOptions.loginEndpoint: "/api/account/login",
    // Define the client id of your application that is needed for the OAuth2.0 Authentication
    sessionManagementOptions.clientId: "oAuthIdTest";

    // OPTIONAL CONFIGURATION
    // ----------------------
    // Add the Symanto Loading Indicator Service to the Session Management
    sessionManagementOptions.loadingIndicatorService = LoadingIndicatorService;
    // Add a prefix to the the access and refresh token cookies
    sessionManagementOptions.tokenPrefix: "my-project_";
    // Set the name of the login state to that the module should navigate after the logout
    sessionManagementOptionsloginStateName: "login"
});

Usage

The only thing you need to do is configuring it as described above. Afterwards it automatically hooks up every HTTP request and checks whether to include a token in it.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published