org.jclouds.cloudstack.features.SessionClient Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of cloudstack Show documentation

jclouds components to access cloudstack

There is a newer version: 1.6.0

/**
 * Licensed to jclouds, Inc. (jclouds) under one or more
 * contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  jclouds licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.jclouds.cloudstack.features;

import java.util.concurrent.TimeUnit;

import org.jclouds.cloudstack.domain.LoginResponse;
import org.jclouds.concurrent.Timeout;

/**
 * Provides synchronous access to CloudStack Sessions
 * 
 * 
 * @see 
 * @author Andrei Savu
 */
@Timeout(duration = 120, timeUnit = TimeUnit.SECONDS)
public interface SessionClient {

   /**
    * Logs a user into Cloudstack.  A successful login attempt will generate a JSESSIONID
    * cookie value that can be passed in subsequent Query command calls until the "logout"
    * command has been issued or the session has expired.
    *
    *
    *
    * @param userName
    *          user account name
    * @param domain
    *          domain name, if empty defaults to ROOT
    * @param hashedPassword
    *          hashed password (by default MD5)
    * @return
    *          login response with session key or null
    */
   LoginResponse loginUserInDomainWithHashOfPassword(String userName, String domain, String hashedPassword);


   /**
    * Logs out the user by invalidating the session key
    *
    * @param sessionKey
    *          user session key
    */
   void logoutUser(String sessionKey);

}

Related Artifacts