How to Implement a Connector

@Override
public String getGuiConfiguration()
{
    /** this data will only be available to the FSM */
    return "";
}

@Override
public String getConnectorConfiguration()
{
    /** this data will be transferred to your backend connector implementation 'as is'. */
    return "";
}

/**
 * Init the panel right after it is being displayed
 * @param sId The ID of this connector provided by translationstudio. Do not change this!
 * @param sConfiguration Configuration as provided by onSaveGuiConfiguration()
 * @param vpQuotas List of available quota configurations (always has at least 1 entry, the "default" quota)
 * @param pCommunicator Object to send custom messages to your backend connector instance
 */
public void onInit(String sId, String sConfiguration, List<IProjectJobConfigurtion> vpQuotas, IExchangeCommunicator pCommunicator)
{
    /** init your JPanel based on the configuration data provided by sXml */
}

/**
 * Create a list of configured projects that will be used by translationstudio and eventually made available
 * to the language mappings dropdown component.
 * @return
 */
@NotNull
List<IConfiguredTranslationMemoryProject> getConfiguredProjects()
{
    final List<IConfiguredTranslationMemoryProject> vpList = new ArrayList<>();

    /*
     * @TODO: Provide at least 1 configured project to use this connector.
     */

    return vpList;
}

/**
 * Hold the configuration
 */
private final Configuration m_pConfiguration = new Configuration();

/**
 * {@inheritDoc }
 */
@Override
public boolean setup(String sTmsId, String sConfigurationXml, String sWorkingDirectory, IConnectorContext pContext)
{
    m_pConfiguration.load(sConfigurationXml);
    return true;
}

/**
 * {@inheritDoc }
 */
@Override
public String getName()
{
    return "Extended Filesystem Connector";
}

/**
 * {@inheritDoc }
 */
@Override
public String getVersion()
{
    return "2.3.0"; /* I am lazy, so I simply use the translationstudio Version */
}

/**
 * {@inheritDoc }
 */
@Override
public ITranslationOperation getTranslationOperation()
{
    return new TranslationOperation(m_pConfiguration);
}

/**
 * {@inheritDoc }
 */
@Override
public ITranslationStatusQueryOperation getTranslationStatusQueryOperation()
{
    return new TranslationStatusQueryOperation();
}

/**
 * {@inheritDoc }
 */
@Override
public IQueryOperation getQueryOperation(String sQueryData)
{
    return new QueryOperation();
}

/**
 * {@inheritDoc }
 */
@Override
public void onUpdateConfiguration(String sConfigurationXml)
{
    /* not needed */
}

/**
 * {@inheritDoc }
 */
@Override
public void onPerformAdditionalTasks()
{
    /* not needed */
}

/**
 * Do nothing
 */
private static class QueryOperation implements IQueryOperation
{
    /**
     * {@inheritDoc }
     */
    @Override
    public void query()
    {
    }

    /**
     * {@inheritDoc }
     */
    @NotNull
    @Override
    public String getResult()
    {
        return "";
    }
}

/**
 * {@inheritDoc }
 */
@Override
public void addTranslatableFiles(List<ITranslatableFilegt; vpList)
{
    /**
     * @TODO: store in a list
     */
}

/**
 * {@inheritDoc }
 */
@Override
public boolean perform()
{
    boolean bSuccess = true;

    /**
     * @TODO: do something with the XML files
     */

    return bSuccess;
}

@Override
public List<ITransferedFile> getResult()
{
    /**
     * @TODO: provide actual elements
     */

    return Collections.emptyList();
}

class TranslationStatusQueryOperation implements ITranslationStatusQueryOperation
{
    /**
     * Get translated data from the TMS
     * @param pFile File Data
     * @param pOutputStream
     * @return success state
     */
    @Nullable
    public boolean downloadTranslation(@NotNull TMSFile pFile, @NotNull IStorableFileStream pOutputStream)
    {
        /*
         * Download the data from the target system. IDs are provided via pFile
         * Simply write the data to the output stream object.
         * The data will only be kept, if this method returns successfully.
         */
    }

    /**
     * Add file status to be queried
     * @param pFileData File Data to lookup in the TMS
     */
    public void addFileToMonitor(@NotNull IFileStatus pFileData)
    {
        /*
         * All files to be monitored will be added via this method.
         */
    }

    /**
     * perform operation
     *
     * @return true, if the result is OK, and FALSE will cause the lookup result to be ignored entirely (e.g. some IOExeption etc.).
     */
    public boolean query()
    {
        /*
         * Check the status of each file provided.
         */
    }
}