org.nuiton.scmwebeditor.api

Interface ScmConnection

public interface ScmConnection

An interface which gives the SCMs main features

Method Summary

Modifier and Type	Method and Description
BrowseResultDto	browse(BrowseDto dto) Searches the repository's files to make a list of them
CommitResultDto	commit(CommitDto dto) Makes a commit of the changed made to the edited file
File	getDiffs(String path, String username, String password, String revision1, String revision2) Gives the content of a file at the specified revision
File	getFileContent(String path, String username, String password) Gives the content of a file
File	getFileContentAtRevision(String path, String username, String password, String revision) Gives the content of a file at the specified revision
String	getFileName() Gives the name of the edited file
String	getFilePath(String address, String repositoryRoot, String username, String password) Gives the path to use to get a file from the repository
String	getHeadRevisionNumber(String path, String username, String password) Gives the number of the head revision
String	getRepositoryId() Gives the repository's unique identifier
Map<ScmRevision,String>	getRevisions(String address, String username, String password) Gives a list of the important revisions for the file at the given address

Method Detail

browse

BrowseResultDto browse(BrowseDto dto)

Searches the repository's files to make a list of them

Parameters:

dto - the DTO which contains all the parameters

Returns:

a DTO which contains all the results

commit

CommitResultDto commit(CommitDto dto)

Makes a commit of the changed made to the edited file

Parameters:

dto - the DTO which contains all the parameters

Returns:

a DTO which contains all the results

getFileContent

File getFileContent(String path,
                    String username,
                    String password)
             throws AuthenticationException

Gives the content of a file

Parameters:

path - the path to the file to get the content from

username - the user's login for the SCM

password - the user's password for the SCM

Returns:

a String which contains the file's content

Throws:

AuthenticationException - if there is a problem during the authentication process

getHeadRevisionNumber

String getHeadRevisionNumber(String path,
                             String username,
                             String password)
                      throws AuthenticationException

Gives the number of the head revision

Parameters:

path - the path to the SCM

username - the user's login for the SCM

password - the user's password for the SCM

Returns:

a String which contains the head revision's number

Throws:

AuthenticationException - if there is a problem during the authentication process

getRepositoryId

String getRepositoryId()

Gives the repository's unique identifier

Returns:

the repository's unique identifier

getFileName

String getFileName()

Gives the name of the edited file

Returns:

the name of the edited file

getFilePath

String getFilePath(String address,
                   String repositoryRoot,
                   String username,
                   String password)

Gives the path to use to get a file from the repository

Parameters:

address - the full address of the file on the repository

repositoryRoot - the address of the repository's root

username - the user's login for the SCM

password - the user's password for the SCM

Returns:

the path to use to get a file from the repository

getRevisions

Map<ScmRevision,String> getRevisions(String address,
                                     String username,
                                     String password)
                              throws AuthenticationException

Gives a list of the important revisions for the file at the given address

Parameters:

address - the file's address

username - the username to use to connect to the repository

password - the password to use to connect to the repository

Returns:

a list of revisions for the file at the given address with their revision name

Throws:

AuthenticationException - if there is a problem during the authentication process

getFileContentAtRevision

File getFileContentAtRevision(String path,
                              String username,
                              String password,
                              String revision)
                       throws AuthenticationException

Gives the content of a file at the specified revision

Parameters:

path - the path to the file to get the content from

username - the user's login for the SCM

password - the user's password for the SCM

revision - the revision ID to use to get the file content

Returns:

a String which contains the file's content

Throws:

AuthenticationException - if there is a problem during the authentication process

getDiffs

File getDiffs(String path,
              String username,
              String password,
              String revision1,
              String revision2)
       throws AuthenticationException

Gives the content of a file at the specified revision

Parameters:

path - the path to the file to get the content from

username - the user's login for the SCM

password - the user's password for the SCM

revision1 - one of the revisions ID to compare

revision2 - the other revision ID to compare

Returns:

a String which contains the file's content

Throws:

AuthenticationException - if there is a problem during the authentication process