@atomist/sdm/src/lib/api/context/AdminCommunicationContext.ts

Atomist Software Delivery Machine SDK

/*
 * Copyright © 2018 Atomist, Inc.
 *
 * 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.
 */

import { SoftwareDeliveryMachine } from "../machine/SoftwareDeliveryMachine";
import { AddressChannels } from "./addressChannels";

/**
 * Context allowing us to communicate with an admin
 */
export interface AdminCommunicationContext {

    /**
     * Address the admin of this SDM
     */
    addressAdmin: AddressChannels;

    /**
     * The SDM that is currently running
     */
    sdm: SoftwareDeliveryMachine;
}