Package com.io7m.idstore.server.api
Interface IdServerType
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
IdServer
A server instance.
-
Method Summary
Modifier and TypeMethodDescriptiondefault URI
adminAPI()
void
close()
void
createOrUpdateInitialAdmin
(UUID adminId, IdName adminName, IdEmail adminEmail, IdRealName adminRealName, String adminPassword) Create the initial admin, or update the existing one if the admin already exists with the given ID.database()
boolean
isClosed()
void
start()
Start the server instance.default URI
userAPI()
default URI
userView()
-
Method Details
-
start
Start the server instance. Can be called multiple times redundantly, and can be called before or after #close() has been called.- Throws:
IdServerException
- On errors
-
database
IdDatabaseType database()- Returns:
- The server's database instance
-
isClosed
boolean isClosed()- Returns:
true
if the server is closed- See Also:
-
close
- Specified by:
close
in interfaceAutoCloseable
- Throws:
IdServerException
-
configuration
IdServerConfiguration configuration()- Returns:
- The configuration used for the server
-
userAPI
- Returns:
- The address of the user API
-
userView
- Returns:
- The address of the user view
-
adminAPI
- Returns:
- The address of the admin API
-
createOrUpdateInitialAdmin
void createOrUpdateInitialAdmin(UUID adminId, IdName adminName, IdEmail adminEmail, IdRealName adminRealName, String adminPassword) throws IdServerException Create the initial admin, or update the existing one if the admin already exists with the given ID.- Parameters:
adminId
- The admin IDadminName
- The initial administrator to createadminEmail
- The admin emailadminRealName
- The admin's real nameadminPassword
- The password for the initial administrator- Throws:
IdServerException
- On errors
-