## Uses of Interface
com.h3c.api.auth.Authentication

- Packages that use Authentication
  Package | Description
  --- | ---
  com.h3c.api.auth |
  com.h3c.keystone |
  com.h3c.sdn.adm | Definitions of the domain model and services specific to the Administrator tier of the VCF Controller.
  com.h3c.sdn.adm.alert | Definitions of the services pertaining to the Alert system.
  com.h3c.sdn.adm.backup |
  com.h3c.sdn.adm.config | Definitions of the services pertaining to the Config system.
  com.h3c.sdn.app | Application management and tracking service interfaces.
  com.h3c.sdn.auth | ...

- - ### Uses of Authentication in com.h3c.api.auth

    Classes in com.h3c.api.auth that implement Authentication
    Modifier and Type | Class and Description
    --- | ---
    `class` | `DefaultAuthentication` Simple carrier of authentication record.

    Methods in com.h3c.api.auth that return Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Authentication` | AuthenticationService.`authenticate(String domain, String user, String password)` Authenticate against the specified domain using the supplied user name and password.
    `Authentication` | AuthenticationService.`validate(String token)` Determines whether the specified authentication token is valid and if so, provides the associated authentication data.

  - ### Uses of Authentication in com.h3c.keystone

    Methods in com.h3c.keystone that return Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Authentication` | KeystoneAuthenticationManager.`authenticate(String domain, String user, String password)`
    `Authentication` | InMemoryAuthenticationManager.`authenticate(String domain, String user, String password)`
    `Authentication` | HttpAuthClient.`authenticate(String domain, String user, String password)`
    `Authentication` | KeystoneAuthenticationManager.`validate(String token)`
    `Authentication` | InMemoryAuthenticationManager.`validate(String token)`
    `Authentication` | HttpAuthClient.`validate(String token)`

  - ### Uses of Authentication in com.h3c.sdn.adm

    Methods in com.h3c.sdn.adm with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `File` | BackupService.`downloadBackup(String systemId, boolean csum, Authentication auth)` Download backup to a safe location
    `BackupStatus` | BackupService.`getBackupStatus(Token token, Authentication auth)` Get backup status.
    `BackupInformation` | BackupService.`getLastRestoreInformation(String systemId, Authentication auth)` Get last restore information.
    `Token` | BackupService.`startSystemBackup(String systemId, Authentication auth)` Backup controller system.
    `Token` | BackupService.`startSystemRestore(String systemId, Authentication auth)` Restore controller system.
    `void` | BackupService.`uploadBackup(String filename, InputStream in, String systemId, Authentication auth)` Upload backup to a URL.

  - ### Uses of Authentication in com.h3c.sdn.adm.alert

    Methods in com.h3c.sdn.adm.alert with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `AlertTopicListener` | AlertTopicListenerService.`registerListener(AlertTopicListener listener, Authentication auth)` Register an alert topic listener.
    `void` | AlertTopicListenerService.`removeListener(Id<AlertTopicListener,UUID> id, Authentication auth)` Removes the Alert Topic Listener with the given unique identifier.
    `AlertTopicListener` | AlertTopicListenerService.`updateListener(AlertTopicListener listener, Authentication auth)` Updates the given alert topic listener.

  - ### Uses of Authentication in com.h3c.sdn.adm.backup

    Methods in com.h3c.sdn.adm.backup with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `File` | BackupServer.`downloadBackup(String backupFolder, boolean csum, Authentication auth)` Method to download the backup file from the controller.
    `File` | BackupRestoreComponent.`downloadBackup(String systemId, boolean csum, Authentication auth)`
    `File` | BackupTeamProxy.`downloadBackup(String systemId, boolean csum, Authentication auth)`
    `BackupStatus` | BackupRestoreComponent.`getBackupStatus(Token token, Authentication auth)`
    `BackupStatus` | BackupTeamProxy.`getBackupStatus(Token token, Authentication auth)`
    `BackupStatus` | BackupServer.`getBackupStatus(Token token, String fileLoc, Authentication auth)` Method to query the backup status.
    `BackupInformation` | BackupServer.`getLastRestoreInformation(String fileLoc, Authentication auth)` Get last restore information.
    `BackupInformation` | BackupRestoreComponent.`getLastRestoreInformation(String systemId, Authentication auth)`
    `BackupInformation` | BackupTeamProxy.`getLastRestoreInformation(String systemId, Authentication auth)`
    `Token` | BackupServer.`startSystemBackup(Authentication auth)` Backup controller system artifacts.
    `Token` | BackupRestoreComponent.`startSystemBackup(String systemId, Authentication auth)`
    `Token` | BackupTeamProxy.`startSystemBackup(String systemId, Authentication auth)`
    `Token` | BackupServer.`startSystemRestore(String backupFolder, Authentication auth)` Method for Restore of a backup file.
    `Token` | BackupRestoreComponent.`startSystemRestore(String systemId, Authentication auth)`
    `Token` | BackupTeamProxy.`startSystemRestore(String systemId, Authentication auth)`
    `void` | BackupServer.`uploadBackup(String fileName, InputStream in, String uploadFolder, Authentication auth)` Method to upload the backup file to the controller.
    `void` | BackupRestoreComponent.`uploadBackup(String filename, InputStream in, String systemId, Authentication auth)`
    `void` | BackupTeamProxy.`uploadBackup(String filename, InputStream in, String systemId, Authentication auth)`

  - ### Uses of Authentication in com.h3c.sdn.adm.config

    Methods in com.h3c.sdn.adm.config with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Config` | ConfigService.`resetAll(String component, Authentication auth)` Reset all configuration items for the given component back to their defaults.
    `Config` | ConfigService.`resetConfigEntries(String component, List<String> keys, Authentication auth)` Reset to default the values for the specified keys of the given component.
    `Config` | ConfigService.`updateConfigEntries(String component, Map<String,String> pairs, Authentication auth)` Update the Config of a given component with the key/value `pairs` supplied.

  - ### Uses of Authentication in com.h3c.sdn.app

    Methods in com.h3c.sdn.app with parameters of type Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Application` | ApplicationService.`install(String appId, Authentication auth)` Installs an application.
    `Application` | ApplicationService.`resolve(String appId, Authentication auth)` Install the application but do not make active.
    `Application` | ApplicationService.`start(String appId, Authentication auth)` Starts an application.
    `Application` | ApplicationService.`stop(String appId, Authentication auth)` Stops an application.
    `void` | ApplicationService.`uninstall(String appId, Authentication auth)` Uninstalls an application.
    `Application` | ApplicationService.`upload(InputStream uploadStream, String fileName, Authentication auth)` Uploads an application archive to the system.

  - ### Uses of Authentication in com.h3c.sdn.auth

    Methods in com.h3c.sdn.auth that return Authentication
    Modifier and Type | Method and Description
    --- | ---
    `Authentication` | SharedSecret.`auth()` Returns the shared authentication interface.

Copyright © 2014. All Rights Reserved.