public interface AuthenticationService
Modifier and Type | Method and Description |
---|---|
void |
checkService()
Checks KeyShield SSO Server status
|
UserInfo |
createUserInfo(String ipAddr)
Retrieves userInfo from KeyShield SSO Server, Returns null if ip address is not validated by server, ip address cannot by validated or ip address is empty
Non-null return value means that ipAddr was approved by KeyShield SSO Server
|
void |
destroy()
Cleanup Authentication service before destruction
|
void |
init()
Initializes Authentication service after creation
|
void |
sendClientMessage(ClientMessage msg)
Sends message to another user(s) idetified by IP or FDN
|
void |
sendClientMessage(String from,
String to,
String message)
Sends message to another user(s) idetified by IP or FDN
|
void checkService() throws KShieldClientException
IllegalStateException
- if service is not initializedKShieldInvalidApiKeyException
- in case of Rejected API KeyKShieldClientException
- in case of other communication or validation errorUserInfo createUserInfo(String ipAddr)
ipAddr
- IP address (usually from servlet request)IllegalStateException
- if service is not initializedvoid destroy()
void init()
void sendClientMessage(ClientMessage msg) throws KShieldClientException
msg
- Client message dataIllegalStateException
- if service is not initializedKShieldInvalidApiKeyException
- in case of Rejected API Key (Used API key must have been properly configured at KShield SSO Server)KShieldClientException
- in case of other communication or validation errorvoid sendClientMessage(String from, String to, String message) throws KShieldClientException
from
- Name (Full Name) of message senderto
- Message target (IP or FDN)message
- Message textIllegalStateException
- if service is not initializedKShieldInvalidApiKeyException
- in case of Rejected API Key (Used API key must have been properly configured at KShield SSO Server)KShieldClientException
- in case of other communication or validation errorCopyright © 2013 TDP Ltd. All Rights Reserved.