/*
 * Copyright (C) 2005-2012 Alfresco Software Limited.
 *
 * This file is part of Alfresco
 *
 * Alfresco is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Alfresco is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 */
package org.alfresco.service.cmr.remotecredentials;

import java.io.Serializable;

import org.alfresco.repo.security.permissions.PermissionCheckValue;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.namespace.QName;

/**
 * This class is the parent of a set of Remote Credentials
 * 
 * @author Nick Burch
 * @since 4.0.2
 */
public interface BaseCredentialsInfo extends Serializable, PermissionCheckValue 
{
   /**
    * @return the NodeRef of the underlying credentials
    */
   NodeRef getNodeRef();
   
   /**
    * @return the Type of the underlying credentials
    */
   QName getCredentialsType();
   
   /**
    * @return the Remote System Name the credentials belong to
    */
   String getRemoteSystemName();
   
   /**
    * @return the NodeRef of the container for the Remote System
    */
   NodeRef getRemoteSystemContainerNodeRef();
   
   /**
    * @return the Remote Username
    */
   String getRemoteUsername();
   
   /**
    * @return whether the last authentication attempt succeeded
    */
   boolean getLastAuthenticationSucceeded();
}