Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## com.atlassian.bamboo.remoteapi.commands
Class LoginCommand

    java.lang.Object
      com.atlassian.bamboo.remoteapi.commands.AbstractCommand
          com.atlassian.bamboo.remoteapi.commands.LoginCommand

    public class LoginCommand

extends AbstractCommand

This class uses the Bamboo rest api to logonto a Bamboo server.

Field Summary

Fields inherited from class com.atlassian.bamboo.remoteapi.commands.AbstractCommand
`HTTP_STATUS_OK`

Constructor Summary
`LoginCommand()`

Method Summary
`String` | `login(String serverUrl, String username, String password)` Uses the remote api to login to the bamboo server

Methods inherited from class com.atlassian.bamboo.remoteapi.commands.AbstractCommand
`executePostMethod, extractTagData, getHttpClient`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### LoginCommand

    public LoginCommand()

Method Detail

### login

    public String login(String serverUrl,
                        String username,
                        String password)

  Uses the remote api to login to the bamboo server

  Parameters:
    `serverUrl` - The URL of the bamboo server
    `username` - The username
    `password` - The password
  Returns:
    The session authentication token used to access the api methods, null if login failed

Overview | Package | Class | Use | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Copyright © 2006 Atlassian Software Systems. All Rights Reserved.