IdAClientType

All Superinterfaces:: AutoCloseable, Closeable, IdAClientAdminsType, IdAClientAuditType, IdAClientUsersType

All Known Implementing Classes:: IdAClient

public interface IdAClientType extends Closeable, IdAClientUsersType, IdAClientAdminsType, IdAClientAuditType

The type of clients.

Method Summary

Modifier and Type

Method

Description

IdAdmin

login(String user, String password, URI base)

Log in.

Methods inherited from interface java.io.Closeable
close

Methods inherited from interface com.io7m.idstore.admin_client.api.IdAClientAdminsType
adminBanCreate, adminBanDelete, adminBanGet, adminCreate, adminDelete, adminEmailAdd, adminEmailRemove, adminGet, adminGetByEmail, adminPermissionGrant, adminPermissionRevoke, adminSearchBegin, adminSearchByEmailBegin, adminSearchByEmailNext, adminSearchByEmailPrevious, adminSearchNext, adminSearchPrevious, adminSelf, adminUpdate

Methods inherited from interface com.io7m.idstore.admin_client.api.IdAClientAuditType
auditSearchBegin, auditSearchNext, auditSearchPrevious

Methods inherited from interface com.io7m.idstore.admin_client.api.IdAClientUsersType
userBanCreate, userBanDelete, userBanGet, userCreate, userCreate, userDelete, userEmailAdd, userEmailRemove, userGet, userGetByEmail, userLoginHistory, userSearchBegin, userSearchByEmailBegin, userSearchByEmailNext, userSearchByEmailPrevious, userSearchNext, userSearchPrevious, userUpdate

Method Details
- login
  
  IdAdmin login(String user, String password, URI base) throws IdAClientException, InterruptedException
  
  Log in.
  
  Parameters:
  
  user - The admin username
  
  password - The password
  
  base - The base URI
  
  Returns:
  
  The logged in admin profile
  
  Throws:
  
  IdAClientException - On errors
  
  InterruptedException - On interruption