alfresco-ng2-components/docs/core/authentication.service.md

Added, Status, Last reviewed

Added	Status	Last reviewed
v2.0.0	Active	2018-03-29

Authentication Service

Provides authentication to ACS and APS.

Class members

Methods

• getBpmUsername(): string
  Gets the BPM username
  • Returns string - The BPM username
• getEcmUsername(): string
  Gets the ECM username.
  • Returns string - The ECM username
• getRedirectUrl(provider: string = null): string
  Gets the URL to redirect to after login.
  • provider: string = null - Service provider. Can be "ECM", "BPM" or "ALL".
  • Returns string - The redirect URL
• getTicketBpm(): string | null
  Gets the BPM ticket stored in the Storage.
  • Returns string | null - The ticket or null if none was found
• getTicketEcm(): string | null
  Gets the ECM ticket stored in the Storage.
  • Returns string | null - The ticket or null if none was found
• getTicketEcmBase64(): string | null
  Gets the BPM ticket from the Storage in Base 64 format.
  • Returns string | null - The ticket or null if none was found
• handleError(error: any = null): Observable<any>
  Prints an error message in the console browser
  • error: any = null - Error message
  • Returns Observable<any> - Object representing the error message
• isBpmLoggedIn(): boolean
  Checks if the user is logged in on a BPM provider.
  • Returns boolean - True if logged in, false otherwise
• isEcmLoggedIn(): boolean
  Checks if the user is logged in on an ECM provider.
  • Returns boolean - True if logged in, false otherwise
• isLoggedIn(): boolean
  Checks if the user logged in.
  • Returns boolean - True if logged in, false otherwise
• isRememberMeSet(): boolean
  Checks whether the "remember me" cookie was set or not.
  • Returns boolean - True if set, false otherwise
• login(username: string = null, password: string = null, rememberMe: boolean = false): Observable<object>
  Logs the user in.
  • username: string = null - Username for the login
  • password: string = null - Password for the login
  • rememberMe: boolean = false - Stores the user's login details if true
  • Returns Observable<object> - Object with auth type ("ECM", "BPM" or "ALL") and auth ticket
• logout(): any
  Logs the user out.
  • Returns any - Response event called when logout is complete
• removeTicket()
  Removes the login ticket from Storage.
• saveTicketAuth()
  Saves the AUTH ticket in the Storage.
• saveTicketBpm()
  Saves the BPM ticket in the Storage.
• saveTicketEcm()
  Saves the ECM ticket in the Storage.
• saveTickets()
  Saves the ECM and BPM ticket in the Storage.
• setRedirectUrl(url: RedirectionModel = null)
  Sets the URL to redirect to after login.
• url: RedirectionModel = null - URL to redirect to

Details

Usage example

import { AuthenticationService } from '@alfresco/adf-core';

@Component({...})
export class AppComponent {
    constructor(authService: AuthenticationService) {
        this.AuthenticationService.login('admin', 'admin').subscribe(
            token => {
                console.log(token);
            },
            error => {
                console.log(error);
            }
        );
    }
}

See also

• Login component