com.helger.photon.connect.generic.IConnector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ph-oton-connect Show documentation

Connectivity part of the ph-oton stack

The newest version!

/*
 * Copyright (C) 2014-2024 Philip Helger (www.helger.com)
 * philip[at]helger[dot]com
 *
 * Licensed 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 com.helger.photon.connect.generic;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

import com.helger.commons.state.EChange;
import com.helger.security.authentication.credentials.IAuthCredentials;

public interface IConnector 
{
  /**
   * @return The destination of this connector.
   */
  @Nonnull
  IConnectionDestination  getDestination ();

  /**
   * @return The internal handle of this connector.
   */
  @Nullable
  HANDLETYPE getHandle ();

  /**
   * A shortcut for
   * {@link IConnectionDestination#openConnection(IAuthCredentials)}.
   *
   * @param aCredentials
   *        The credentials to use.
   * @return {@link EChange}
   */
  @Nonnull
  EChange openConnection (@Nonnull IAuthCredentials aCredentials);

  /**
   * A shortcut for {@link IConnectionDestination#closeConnection(Object)}.
   *
   * @return {@link EChange}
   */
  @Nonnull
  EChange closeConnection ();

  /**
   * @return true if connection is open, false
   *         otherwise.
   */
  boolean isConnectionOpen ();
}