Package com.mooltiverse.oss.nyx.git

Interface Repository

public interface Repository
This interface models coarse grained, implementation independent methods used by Nyx to access a Git repository.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEFAULT_REMOTE_NAME
    The default remote name.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(Collection<String> paths)
    Adds the given paths to the staging area.
    Commit
    commit(String message)
    Commits changes to the repository.
    Commit
    commit(String message, Identity author, Identity committer)
    Commits changes to the repository.
    Commit
    commit(Collection<String> paths, String message)
    Adds the given files to the staging area and commits changes to the repository.
    Commit
    commit(Collection<String> paths, String message, Identity author, Identity committer)
    Adds the given files to the staging area and commits changes to the repository.
    Set<Tag>
    getCommitTags(String commit)
    Returns a set of objects representing all the tags for the given commit.
    String
    getCurrentBranch()
    Returns the name of the current branch or a commit SHA-1 if the repository is in the detached head state.
    String
    getLatestCommit()
    Returns the SHA-1 identifier of the last commit in the current branch.
    Set<String>
    getRemoteNames()
    Returns the names of configured remote repositories.
    String
    getRootCommit()
    Returns the SHA-1 identifier of the first commit in the repository (the only commit with no parents).
    Set<Tag>
    getTags()
    Returns a set of objects representing all the tags for the repository.
    boolean
    isClean()
    Returns true if the repository is clean, which is when no differences exist between the working tree, the index, and the current HEAD.
    String
    push(String privateKey, byte[] passphrase)
    Pushes local changes in the current branch to the default remote origin.
    String
    push(String user, String password)
    Pushes local changes in the current branch to the default remote origin.
    String
    push(String remote, String privateKey, byte[] passphrase)
    Pushes local changes in the current branch to the given remote using no authentication.
    String
    push(String remote, String privateKey, byte[] passphrase, boolean force)
    Pushes local changes in the current branch to the given remote using no authentication.
    String
    push(String remote, String user, String password)
    Pushes local changes in the current branch to the given remote.
    String
    push(String remote, String user, String password, boolean force)
    Pushes local changes in the current branch to the given remote.
    Set<String>
    push(Collection<String> remotes, String privateKey, byte[] passphrase)
    Pushes local changes in the current branch to the given remotes.
    Set<String>
    push(Collection<String> remotes, String user, String password)
    Pushes local changes in the current branch to the given remotes.
    Tag
    tag(String name)
    Tags the latest commit in the current branch with a tag with the given name.
    Tag
    tag(String name, String message)
    Tags the latest commit in the current branch with a tag with the given name and optional message.
    Tag
    tag(String name, String message, boolean force)
    Tags the latest commit in the current branch with a tag with the given name and optional message.
    Tag
    tag(String name, String message, Identity tagger)
    Tags the latest commit in the current branch with a tag with the given name and optional message using the optional tagger identity.
    Tag
    tag(String target, String name, String message, Identity tagger)
    Tags the object represented by the given SHA-1 with a tag with the given name and optional message using the optional tagger identity.
    Tag
    tag(String target, String name, String message, Identity tagger, boolean force)
    Tags the object represented by the given SHA-1 with a tag with the given name and optional message using the optional tagger identity.
    void
    walkHistory(String start, String end, CommitVisitor visitor)
    Browse the repository commit history using the given visitor to inspect each commit.

  • Field Details

    • DEFAULT_REMOTE_NAME

      static final String DEFAULT_REMOTE_NAME
      The default remote name. Value: "origin".
      See Also:

  • Method Details

    • add

      void add(Collection<String> paths) throws GitException
      Adds the given paths to the staging area.
      Parameters:
      paths - the file patterns of the contents to add to stage. Cannot be null or empty. The path "." represents all files in the working area so with that you can add all locally changed files.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to add paths.
      See Also:

    • commit

      Commit commit(String message) throws GitException
      Commits changes to the repository. Files to commit must be staged separately using add(Collection).
      Parameters:
      message - the commit message. Cannot be null.
      Returns:
      the object modelling the new commit that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to commit.
      See Also:

    • commit

      Commit commit(String message, Identity author, Identity committer) throws GitException
      Commits changes to the repository. Files to commit must be staged separately using add(Collection).
      Parameters:
      message - the commit message. Cannot be null.
      author - the object modelling the commit author informations. It may be null, in which case the default for the repository will be used
      committer - the object modelling the committer informations. It may be null, in which case the default for the repository will be used
      Returns:
      the object modelling the new commit that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to commit.
      See Also:

    • commit

      Commit commit(Collection<String> paths, String message) throws GitException
      Adds the given files to the staging area and commits changes to the repository. This method is a shorthand for add(Collection) and commit(String).
      Parameters:
      paths - the file patterns of the contents to add to stage. Cannot be null or empty. The path "." represents all files in the working area so with that you can add all locally changed files.
      message - the commit message. Cannot be null.
      Returns:
      the object modelling the new commit that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to commit.

    • commit

      Commit commit(Collection<String> paths, String message, Identity author, Identity committer) throws GitException
      Adds the given files to the staging area and commits changes to the repository. This method is a shorthand for add(Collection) and commit(String, Identity, Identity).
      Parameters:
      paths - the file patterns of the contents to add to stage. Cannot be null or empty. The path "." represents all files in the working area so with that you can add all locally changed files.
      message - the commit message. Cannot be null.
      author - the object modelling the commit author informations. It may be null, in which case the default for the repository will be used
      committer - the object modelling the committer informations. It may be null, in which case the default for the repository will be used
      Returns:
      the object modelling the new commit that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to commit.

    • getCommitTags

      Set<Tag> getCommitTags(String commit) throws GitException
      Returns a set of objects representing all the tags for the given commit.
      Parameters:
      commit - the SHA-1 identifier of the commit to get the tags for. It can be a full or abbreviated SHA-1.
      Returns:
      the set of objects representing all the tags for the given commit.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository.

    • getCurrentBranch

      String getCurrentBranch() throws GitException
      Returns the name of the current branch or a commit SHA-1 if the repository is in the detached head state.
      Returns:
      the name of the current branch or a commit SHA-1 if the repository is in the detached head state.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or is in the 'detached HEAD' state.

    • getLatestCommit

      String getLatestCommit() throws GitException
      Returns the SHA-1 identifier of the last commit in the current branch.
      Returns:
      the SHA-1 identifier of the last commit in the current branch.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or is in the 'detached HEAD' state.

    • getRemoteNames

      Set<String> getRemoteNames() throws GitException
      Returns the names of configured remote repositories.
      Returns:
      the names of configured remote repositories.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or is in the 'detached HEAD' state.

    • getRootCommit

      String getRootCommit() throws GitException
      Returns the SHA-1 identifier of the first commit in the repository (the only commit with no parents).
      Returns:
      the SHA-1 identifier of the first commit in the repository.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or is in the 'detached HEAD' state.

    • getTags

      Set<Tag> getTags() throws GitException
      Returns a set of objects representing all the tags for the repository.
      Returns:
      the set of objects representing all the tags for the repository.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository.

    • isClean

      boolean isClean() throws GitException
      Returns true if the repository is clean, which is when no differences exist between the working tree, the index, and the current HEAD.
      Returns:
      true if the repository is clean, false otherwise.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or is in the 'detached HEAD' state.

    • push

      String push(String user, String password) throws GitException
      Pushes local changes in the current branch to the default remote origin. This method allows using user name and password authentication (also used for tokens).
      Parameters:
      user - the user name to create when credentials are required. If this and password are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      password - the password to create when credentials are required. If this and user are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      String push(String privateKey, byte[] passphrase) throws GitException
      Pushes local changes in the current branch to the default remote origin. This method allows using SSH authentication.
      Parameters:
      privateKey - the SSH private key. If null the private key will be searched in its default location (i.e. in the users' $HOME/.ssh directory).
      passphrase - the optional password to use to open the private key, in case it's protected by a passphrase. This is required when the private key is password protected as this implementation does not support prompting the user interactively for entering the password.
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      String push(String remote, String user, String password) throws GitException
      Pushes local changes in the current branch to the given remote. This method allows using user name and password authentication (also used for tokens).
      Parameters:
      remote - the name of the remote to push to. If null or empty the default remote name (origin) is used.
      user - the user name to create when credentials are required. If this and password are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      password - the password to create when credentials are required. If this and user are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      String push(String remote, String user, String password, boolean force) throws GitException
      Pushes local changes in the current branch to the given remote. This method allows using user name and password authentication (also used for tokens).
      Parameters:
      remote - the name of the remote to push to. If null or empty the default remote name (origin) is used.
      user - the user name to create when credentials are required. If this and password are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      password - the password to create when credentials are required. If this and user are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      force - set it to true if you want the push to be executed using the force option
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      String push(String remote, String privateKey, byte[] passphrase) throws GitException
      Pushes local changes in the current branch to the given remote using no authentication. This method allows using SSH authentication.
      Parameters:
      remote - the name of the remote to push to. If null or empty the default remote name (origin) is used.
      privateKey - the SSH private key. If null the private key will be searched in its default location (i.e. in the users' $HOME/.ssh directory).
      passphrase - the optional password to use to open the private key, in case it's protected by a passphrase. This is required when the private key is password protected as this implementation does not support prompting the user interactively for entering the password.
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      String push(String remote, String privateKey, byte[] passphrase, boolean force) throws GitException
      Pushes local changes in the current branch to the given remote using no authentication. This method allows using SSH authentication.
      Parameters:
      remote - the name of the remote to push to. If null or empty the default remote name (origin) is used.
      privateKey - the SSH private key. If null the private key will be searched in its default location (i.e. in the users' $HOME/.ssh directory).
      passphrase - the optional password to use to open the private key, in case it's protected by a passphrase. This is required when the private key is password protected as this implementation does not support prompting the user interactively for entering the password.
      force - set it to true if you want the push to be executed using the force option
      Returns:
      the local name of the remotes that has been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.
      See Also:

    • push

      Set<String> push(Collection<String> remotes, String user, String password) throws GitException
      Pushes local changes in the current branch to the given remotes. This method allows using user name and password authentication (also used for tokens).
      Parameters:
      remotes - the names of remotes to push to. If null or empty the default remote name (origin) is used.
      user - the user name to create when credentials are required. If this and password are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      password - the password to create when credentials are required. If this and user are both null then no credentials is used. When using single token authentication (i.e. OAuth or Personal Access Tokens) this value may be the token or something other than a token, depending on the remote provider.
      Returns:
      a collection with the local names of remotes that have been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.

    • push

      Set<String> push(Collection<String> remotes, String privateKey, byte[] passphrase) throws GitException
      Pushes local changes in the current branch to the given remotes. This method allows using SSH authentication.
      Parameters:
      remotes - the names of remotes to push to. If null or empty the default remote name (origin) is used.
      privateKey - the SSH private key. If null the private key will be searched in its default location (i.e. in the users' $HOME/.ssh directory).
      passphrase - the optional password to use to open the private key, in case it's protected by a passphrase. This is required when the private key is password protected as this implementation does not support prompting the user interactively for entering the password.
      Returns:
      a collection with the local names of remotes that have been pushed
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to push.

    • tag

      Tag tag(String name) throws GitException
      Tags the latest commit in the current branch with a tag with the given name. The resulting tag is lightweight. If the tag already exists it's updated.
      Parameters:
      name - the name of the tag. Cannot be null
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • tag

      Tag tag(String name, String message) throws GitException
      Tags the latest commit in the current branch with a tag with the given name and optional message. If the tag already exists it's updated.
      Parameters:
      name - the name of the tag. Cannot be null
      message - the optional tag message. If null the new tag will be lightweight, otherwise it will be an annotated tag
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • tag

      Tag tag(String name, String message, boolean force) throws GitException
      Tags the latest commit in the current branch with a tag with the given name and optional message. If the tag already exists it's updated.
      Parameters:
      name - the name of the tag. Cannot be null
      message - the optional tag message. If null the new tag will be lightweight, otherwise it will be an annotated tag
      force - set it to true if you want the tag to be applied using the force option
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • tag

      Tag tag(String name, String message, Identity tagger) throws GitException
      Tags the latest commit in the current branch with a tag with the given name and optional message using the optional tagger identity. If the tag already exists it's updated.
      Parameters:
      name - the name of the tag. Cannot be null
      message - the optional tag message. If null the new tag will be lightweight, otherwise it will be an annotated tag
      tagger - the optional identity of the tagger. If null Git defaults are used. If message is null this is ignored.
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • tag

      Tag tag(String target, String name, String message, Identity tagger) throws GitException
      Tags the object represented by the given SHA-1 with a tag with the given name and optional message using the optional tagger identity. If the tag already exists it's updated.
      Parameters:
      target - the SHA-1 identifier of the object to tag. If null the latest commit in the current branch is tagged.
      name - the name of the tag. Cannot be null
      message - the optional tag message. If null the new tag will be lightweight, otherwise it will be an annotated tag
      tagger - the optional identity of the tagger. If null Git defaults are used. If message is null this is ignored.
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • tag

      Tag tag(String target, String name, String message, Identity tagger, boolean force) throws GitException
      Tags the object represented by the given SHA-1 with a tag with the given name and optional message using the optional tagger identity. If the tag already exists it's updated.
      Parameters:
      target - the SHA-1 identifier of the object to tag. If null the latest commit in the current branch is tagged.
      name - the name of the tag. Cannot be null
      message - the optional tag message. If null the new tag will be lightweight, otherwise it will be an annotated tag
      tagger - the optional identity of the tagger. If null Git defaults are used. If message is null this is ignored.
      force - set it to true if you want the tag to be applied using the force option
      Returns:
      the object modelling the new tag that was created. Never null.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, preventing to tag (i.e. when the tag name is null).

    • walkHistory

      void walkHistory(String start, String end, CommitVisitor visitor) throws GitException
      Browse the repository commit history using the given visitor to inspect each commit. Commits are evaluated in Git's natural order, from the most recent to oldest.
      Parameters:
      start - the optional SHA-1 id of the commit to start from. If null the latest commit in the current branch (HEAD) is used. This can be a long or abbreviated SHA-1. If this commit cannot be resolved within the repository a GitException is thrown.
      end - the optional SHA-1 id of the commit to end with, included. If null the repository root commit is used (until the given visitor returns false). If this commit is not reachable from the start it will be ignored. This can be a long or abbreviated SHA-1. If this commit cannot be resolved within the repository a GitException is thrown.
      visitor - the visitor function that will receive commit data to evaluate. If null this method takes no action.
      Throws:
      GitException - in case some problem is encountered with the underlying Git repository, including when the repository has no commits yet or a given commit identifier cannot be resolved.