001/* 002 * CDDL HEADER START 003 * 004 * The contents of this file are subject to the terms of the 005 * Common Development and Distribution License, Version 1.0 only 006 * (the "License"). You may not use this file except in compliance 007 * with the License. 008 * 009 * You can obtain a copy of the license at 010 * docs/licenses/cddl.txt 011 * or http://www.opensource.org/licenses/cddl1.php. 012 * See the License for the specific language governing permissions 013 * and limitations under the License. 014 * 015 * When distributing Covered Code, include this CDDL HEADER in each 016 * file and include the License file at 017 * docs/licenses/cddl.txt. If applicable, 018 * add the following below this CDDL HEADER, with the fields enclosed 019 * by brackets "[]" replaced with your own identifying information: 020 * Portions Copyright [yyyy] [name of copyright owner] 021 * 022 * CDDL HEADER END 023 * 024 * 025 * Copyright 2018-2021 Ping Identity Corporation 026 */ 027package com.unboundid.directory.sdk.sync.types; 028 029/** 030 * This interface provides basic contextual information about a 031 * SyncSource and the SyncPipe that is actively using it. It is intended to 032 * be extended for other Sync Sources so that additional context can be 033 * provided. 034 */ 035public interface SyncSourceContext { 036 /** 037 * Returns the active Sync Pipe. 038 * @return The Sync Pipe. 039 */ 040 String getSyncPipeName(); 041 042 /** 043 * Returns the name of the Sync Source. 044 * @return The name of the Sync Source. 045 */ 046 String getName(); 047}