Package org.apache.syncope.core.provisioning.java.pushpull.stream

Class CSVStreamConnector

java.lang.Object
org.apache.syncope.core.provisioning.java.pushpull.stream.CSVStreamConnector
All Implemented Interfaces:
AutoCloseable, Connector
public class CSVStreamConnector extends Object implements Connector, AutoCloseable

  • Constructor Details

    • CSVStreamConnector

      public CSVStreamConnector(String keyColumn, String arrayElementsSeparator, com.fasterxml.jackson.dataformat.csv.CsvSchema.Builder schemaBuilder, InputStream in, OutputStream out, String... columns)

  • Method Details

    • close

      public void close() throws IOException
      Specified by:
      close in interface AutoCloseable
      Throws:
      IOException

    • reader

      public MappingIterator<Map<String,String>> reader() throws IOException
      Throws:
      IOException

    • getColumns

      public List<String> getColumns(CSVPullSpec spec) throws IOException
      Throws:
      IOException

    • writer

      public SequenceWriter writer() throws IOException
      Throws:
      IOException

    • authenticate

      public Uid authenticate(String username, String password, OperationOptions options)
      Description copied from interface: Connector
      Authenticate user on a connector instance.
      Specified by:
      authenticate in interface Connector
      Parameters:
      username - the name based credential for authentication
      password - the password based credential for authentication
      options - ConnId's OperationOptions
      Returns:
      Uid of the account that was used to authenticate

    • getConnInstance

      public ConnInstance getConnInstance()
      Description copied from interface: Connector
      Getter for active connector instance.
      Specified by:
      getConnInstance in interface Connector
      Returns:
      active connector instance.

    • create

      public Uid create(ObjectClass objectClass, Set<Attribute> attrs, OperationOptions options, Mutable<Boolean> propagationAttempted)
      Description copied from interface: Connector
      Create user, group or any object on a connector instance.
      Specified by:
      create in interface Connector
      Parameters:
      objectClass - ConnId's object class
      attrs - attributes for creation
      options - ConnId's OperationOptions
      propagationAttempted - if creation is actually performed (based on connector instance's capabilities)
      Returns:
      Uid for created object

    • update

      public Uid update(ObjectClass objectClass, Uid uid, Set<Attribute> attrs, OperationOptions options, Mutable<Boolean> propagationAttempted)
      Description copied from interface: Connector
      Update user, group or any object on a connector instance.
      Specified by:
      update in interface Connector
      Parameters:
      objectClass - ConnId's object class
      uid - remote identifier
      attrs - attributes for update
      options - ConnId's OperationOptions
      propagationAttempted - if creation is actually performed (based on connector instance's capabilities)
      Returns:
      Uid for updated object

    • updateDelta

      public Set<AttributeDelta> updateDelta(ObjectClass objectClass, Uid uid, Set<AttributeDelta> modifications, OperationOptions options, Mutable<Boolean> propagationAttempted)
      Description copied from interface: Connector
      Partial update user, group or any object on a connector instance.
      Specified by:
      updateDelta in interface Connector
      Parameters:
      objectClass - ConnId's object class
      uid - remote identifier
      modifications - attribute modifications to apply
      options - ConnId's OperationOptions
      propagationAttempted - if creation is actually performed (based on connector instance's capabilities)
      Returns:
      the applied modifications

    • delete

      public void delete(ObjectClass objectClass, Uid uid, OperationOptions options, Mutable<Boolean> propagationAttempted)
      Description copied from interface: Connector
      Delete user, group or any object on a connector instance.
      Specified by:
      delete in interface Connector
      Parameters:
      objectClass - ConnId's object class
      uid - user to be deleted
      options - ConnId's OperationOptions
      propagationAttempted - if deletion is actually performed (based on connector instance's capabilities)

    • sync

      public void sync(ObjectClass objectClass, SyncToken token, SyncResultsHandler handler, OperationOptions options)
      Description copied from interface: Connector
      Sync remote objects from a connector instance.
      Specified by:
      sync in interface Connector
      Parameters:
      objectClass - ConnId's object class
      token - to be passed to the underlying connector
      handler - to be used to handle deltas
      options - ConnId's OperationOptions

    • getLatestSyncToken

      public SyncToken getLatestSyncToken(ObjectClass objectClass)
      Description copied from interface: Connector
      Read latest sync token from a connector instance.
      Specified by:
      getLatestSyncToken in interface Connector
      Parameters:
      objectClass - ConnId's object class.
      Returns:
      latest sync token

    • livesync

      public void livesync(ObjectClass objectClass, LiveSyncResultsHandler handler, OperationOptions options)
      Description copied from interface: Connector
      Live sync remote objects from a connector instance.
      Specified by:
      livesync in interface Connector
      Parameters:
      objectClass - ConnId's object class
      handler - to be used to handle deltas
      options - ConnId's OperationOptions

    • getObject

      public ConnectorObject getObject(ObjectClass objectClass, Attribute connObjectKey, boolean ignoreCaseMatch, OperationOptions options)
      Description copied from interface: Connector
      Get remote object.
      Specified by:
      getObject in interface Connector
      Parameters:
      objectClass - ConnId's object class
      connObjectKey - ConnId's key attribute
      ignoreCaseMatch - whether match should be performed regardless of the value case
      options - ConnId's OperationOptions
      Returns:
      ConnId's connector object for given uid

    • search

      public SearchResult search(ObjectClass objectClass, Filter filter, SearchResultsHandler handler, OperationOptions options)
      Description copied from interface: Connector
      Search for remote objects.
      Specified by:
      search in interface Connector
      Parameters:
      objectClass - ConnId's object class
      filter - search filter
      handler - class responsible for working with the objects returned from the search; may be null.
      options - ConnId's OperationOptions
      Returns:
      search result

    • getObjectClassInfo

      public Set<ObjectClassInfo> getObjectClassInfo()
      Description copied from interface: Connector
      Builds metadata description of ConnId ObjectClass.
      Specified by:
      getObjectClassInfo in interface Connector
      Returns:
      metadata description of ConnId ObjectClass

    • validate

      public void validate()
      Description copied from interface: Connector
      Validate connector instance.
      Specified by:
      validate in interface Connector

    • test

      public void test()
      Description copied from interface: Connector
      Check connection.
      Specified by:
      test in interface Connector

    • dispose

      public void dispose()
      Description copied from interface: Connector
      Dispose of any resources associated with connector instance.
      Specified by:
      dispose in interface Connector