Package com.mooltiverse.oss.nyx.services

Interface GitUser

All Known Implementing Classes:

GitHubUser, GitLabUser

public interface GitUser

A user for a remote Git service.

Method Summary

Modifier and Type	Method	Description
String	geFullName()	Returns the full name of this user.
Map<String,Object>	getAttributes()	Returns a read-only map with all the raw properties for the user.
String	getID()	Returns the ID of this user.
String	getUserName()	Returns the user name of this user.
void	update()	Updates the user data and attributes.

Method Detail

getAttributes

Map<String,Object> getAttributes()

Returns a read-only map with all the raw properties for the user.

Returns:

a read-only map with all the raw properties for the user.

getID

String getID()

Returns the ID of this user.

Returns:

the ID of this user.

getUserName

String getUserName()

Returns the user name of this user.

Returns:

the user name of this user.

geFullName

String geFullName()

Returns the full name of this user.

Returns:

the full name of this user. If not vailable then null is returned.

update

void update()
     throws GitTransportException,
            GitAuthenticationException

Updates the user data and attributes. This method might be useful when the remote data has changed and you need to update the local status.

Throws:

GitTransportException - if a transport related error occurs while communicating with the server

GitAuthenticationException - if authentication fails