Poco::OSP::Shell

class LoginCommand

File Information

Library: OSP/Shell
Package: Shell
Header: Poco/OSP/Shell/LoginCommand.h

Description

LoginCommand implements the "login" command, with the help of the Session object.

The login command takes two arguments, a user name and a password, and passes them to the login() member function of Session.

The help text of the login command can be customized by providing the following bundle properties:

  • login.description: The description of the command.
  • login.usage: The usage string.

Inheritance

Direct Base Classes: AbstractCommand

All Base Classes: AbstractCommand, Command

Member Summary

Member Functions: executeImpl

Inherited Functions: commandName, defineOptions, displayHelp, execute, executeImpl, handleHelp, handleOption, options, processOptions, stopOptionsProcessing

Constructors

LoginCommand

LoginCommand(
    Poco::OSP::BundleContext::Ptr pContext
);

Creates the LoginCommand.

Destructor

~LoginCommand virtual

~LoginCommand();

Destroys the LoginCommand.

Member Functions

executeImpl protected virtual

virtual int executeImpl(
    Session & session,
    const std::vector < std::string > & args,
    std::ostream & ostr
);