AuthImpl (OpenKM SDK for Java 3.13 API)

java.lang.Object
- com.openkm.sdk4j.impl.ClientImpl
- - com.openkm.sdk4j.impl.AuthImpl

All Implemented Interfaces:

BaseAuth, Serializable
```
public class AuthImpl
extends ClientImpl
implements BaseAuth, Serializable
```
Auth

Author:

jllort

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AuthImpl(String host)
OKMAuth

Constructors
Constructor and Description
`AuthImpl(String host)` OKMAuth

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`assignRole(String userId, String roleId)`
`void`	`changeSecurity(String uuid, ChangeSecurity changeSecurity)`
`void`	`createRole(String roleId, boolean active)`
`void`	`createUser(String userId, String password, String email, String name, boolean active)`
`void`	`deleteRole(String roleId)`
`void`	`deleteUser(String userId)`
`Map<String,Integer>`	`getGrantedRoles(String uuid)`
`Map<String,Integer>`	`getGrantedUsers(String uuid)`
`GrantedUsersAndRolesItem`	`getGrantedUsersAndRoles(String uuid)`
`List<Profile>`	`getProfiles(boolean filterByActive)`
`List<String>`	`getRoles(boolean showAll)`
`List<String>`	`getRolesByUser(String userId)`
`String`	`getSessionId()`
`CommonUser`	`getUser(String userId)`
`Profile`	`getUserProfile(String userId)`
`List<CommonUser>`	`getUsers(boolean showAll)`
`List<CommonUser>`	`getUsersByRole(String roleId)`
`List<Tenant>`	`getUserTenants()`
`void`	`grantRole(String uuid, String roleId, int permissions, boolean recursive)`
`void`	`grantUser(String uuid, String userId, int permissions, boolean recursive)`
`boolean`	`hasSecurityRecursive()`
`boolean`	`isAdmin()`
`boolean`	`isLoginLowercase()`
`boolean`	`isPasswordExpired()`
`protected String`	`login(String user, String password)`
`protected String`	`login(String user, String password, int expiration, boolean restrictIp)`
`protected void`	`logout()`
`void`	`removeRole(String userId, String roleId)`
`void`	`revokeRole(String uuid, String roleId, int permissions, boolean recursive)`
`void`	`revokeUser(String uuid, String userId, int permissions, boolean recursive)`
`void`	`setAuthorizationToken(String authorizationToken)` setAuthenticationToken
`void`	`setRolePermissions(String uuid, String roleId, int permissions, boolean recursive)`
`void`	`setUserPermissions(String uuid, String userId, int permissions, boolean recursive)`
`void`	`setUserProfile(String userId, long profileId)`
`void`	`setUserTenant(long tenantId)`
`void`	`updateRole(String roleId, boolean active)`
`void`	`updateUser(String userId, String password, String email, String name, boolean active)`

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl
getClient, resource, resource

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- AuthImpl
```
public AuthImpl(String host)
```
  OKMAuth

Method Detail

setAuthorizationToken
```
public void setAuthorizationToken(String authorizationToken)
```
setAuthenticationToken

Specified by:

setAuthorizationToken in interface BaseAuth

login

protected String login(String user,
                       String password)
                throws UnknownException,
                       WebserviceException,
                       AuthenticationException

Throws:: UnknownException; WebserviceException; AuthenticationException

login

protected String login(String user,
                       String password,
                       int expiration,
                       boolean restrictIp)
                throws UnknownException,
                       WebserviceException,
                       AuthenticationException

Throws:: UnknownException; WebserviceException; AuthenticationException

logout

protected void logout()
               throws UnknownException,
                      WebserviceException

Throws:: UnknownException; WebserviceException

getSessionId

public String getSessionId()
                    throws UnknownException,
                           WebserviceException

Specified by:: getSessionId in interface BaseAuth
Throws:: UnknownException; WebserviceException

getGrantedUsersAndRoles

public GrantedUsersAndRolesItem getGrantedUsersAndRoles(String uuid)
                                                 throws AccessDeniedException,
                                                        RepositoryException,
                                                        DatabaseException,
                                                        PathNotFoundException,
                                                        UnknownException,
                                                        WebserviceException

Specified by:: getGrantedUsersAndRoles in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

getGrantedRoles

public Map<String,Integer> getGrantedRoles(String uuid)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException

Specified by:: getGrantedRoles in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; WebserviceException; UnknownException

getGrantedUsers

public Map<String,Integer> getGrantedUsers(String uuid)
                                    throws AccessDeniedException,
                                           RepositoryException,
                                           DatabaseException,
                                           PathNotFoundException,
                                           WebserviceException,
                                           UnknownException

Specified by:: getGrantedUsers in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; WebserviceException; UnknownException

getRoles

public List<String> getRoles(boolean showAll)
                      throws AccessDeniedException,
                             RepositoryException,
                             DatabaseException,
                             PrincipalAdapterException,
                             WebserviceException,
                             UnknownException

Specified by:: getRoles in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; WebserviceException; UnknownException

getRolesByUser

public List<String> getRolesByUser(String userId)
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   PrincipalAdapterException,
                                   WebserviceException,
                                   UnknownException

Specified by:: getRolesByUser in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; WebserviceException; UnknownException

getUsers

public List<CommonUser> getUsers(boolean showAll)
                          throws AccessDeniedException,
                                 RepositoryException,
                                 DatabaseException,
                                 PrincipalAdapterException,
                                 UnknownException,
                                 WebserviceException

Specified by:: getUsers in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; UnknownException; WebserviceException

getUser

public CommonUser getUser(String userId)
                   throws AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          PrincipalAdapterException,
                          UnknownException,
                          WebserviceException

Specified by:: getUser in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; UnknownException; WebserviceException

getUsersByRole

public List<CommonUser> getUsersByRole(String roleId)
                                throws AccessDeniedException,
                                       RepositoryException,
                                       DatabaseException,
                                       PrincipalAdapterException,
                                       UnknownException,
                                       WebserviceException

Specified by:: getUsersByRole in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PrincipalAdapterException; UnknownException; WebserviceException

revokeRole

public void revokeRole(String uuid,
                       String roleId,
                       int permissions,
                       boolean recursive)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       PathNotFoundException,
                       UnknownException,
                       WebserviceException

Specified by:: revokeRole in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

revokeUser

public void revokeUser(String uuid,
                       String userId,
                       int permissions,
                       boolean recursive)
                throws AccessDeniedException,
                       RepositoryException,
                       DatabaseException,
                       PathNotFoundException,
                       UnknownException,
                       WebserviceException

Specified by:: revokeUser in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

grantRole

public void grantRole(String uuid,
                      String roleId,
                      int permissions,
                      boolean recursive)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PathNotFoundException,
                      UnknownException,
                      WebserviceException

Specified by:: grantRole in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

grantUser

public void grantUser(String uuid,
                      String userId,
                      int permissions,
                      boolean recursive)
               throws AccessDeniedException,
                      RepositoryException,
                      DatabaseException,
                      PathNotFoundException,
                      UnknownException,
                      WebserviceException

Specified by:: grantUser in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

createUser

public void createUser(String userId,
                       String password,
                       String email,
                       String name,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: createUser in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

deleteUser

public void deleteUser(String userId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: deleteUser in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

updateUser

public void updateUser(String userId,
                       String password,
                       String email,
                       String name,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: updateUser in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

createRole

public void createRole(String roleId,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: createRole in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

deleteRole

public void deleteRole(String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: deleteRole in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

updateRole

public void updateRole(String roleId,
                       boolean active)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: updateRole in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

assignRole

public void assignRole(String userId,
                       String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: assignRole in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

removeRole

public void removeRole(String userId,
                       String roleId)
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: removeRole in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

changeSecurity

public void changeSecurity(String uuid,
                           ChangeSecurity changeSecurity)
                    throws PathNotFoundException,
                           AccessDeniedException,
                           RepositoryException,
                           DatabaseException,
                           UnknownException,
                           WebserviceException

Specified by:: changeSecurity in interface BaseAuth
Throws:: PathNotFoundException; AccessDeniedException; RepositoryException; DatabaseException; UnknownException; WebserviceException

getProfiles

public List<Profile> getProfiles(boolean filterByActive)
                          throws PrincipalAdapterException,
                                 WebserviceException,
                                 UnknownException

Specified by:: getProfiles in interface BaseAuth
Throws:: PrincipalAdapterException; WebserviceException; UnknownException

getUserProfile

public Profile getUserProfile(String userId)
                       throws PrincipalAdapterException,
                              WebserviceException,
                              UnknownException

Specified by:: getUserProfile in interface BaseAuth
Throws:: PrincipalAdapterException; WebserviceException; UnknownException

setUserProfile

public void setUserProfile(String userId,
                           long profileId)
                    throws PrincipalAdapterException,
                           WebserviceException,
                           UnknownException

Specified by:: setUserProfile in interface BaseAuth
Throws:: PrincipalAdapterException; WebserviceException; UnknownException

setUserPermissions

public void setUserPermissions(String uuid,
                               String userId,
                               int permissions,
                               boolean recursive)
                        throws AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               PathNotFoundException,
                               UnknownException,
                               WebserviceException

Specified by:: setUserPermissions in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

setRolePermissions

public void setRolePermissions(String uuid,
                               String roleId,
                               int permissions,
                               boolean recursive)
                        throws AccessDeniedException,
                               RepositoryException,
                               DatabaseException,
                               PathNotFoundException,
                               UnknownException,
                               WebserviceException

Specified by:: setRolePermissions in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

getUserTenants

public List<Tenant> getUserTenants()
                            throws AccessDeniedException,
                                   RepositoryException,
                                   DatabaseException,
                                   PathNotFoundException,
                                   UnknownException,
                                   WebserviceException

Specified by:: getUserTenants in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

setUserTenant

public void setUserTenant(long tenantId)
                   throws AccessDeniedException,
                          RepositoryException,
                          DatabaseException,
                          PathNotFoundException,
                          UnknownException,
                          WebserviceException

Specified by:: setUserTenant in interface BaseAuth
Throws:: AccessDeniedException; RepositoryException; DatabaseException; PathNotFoundException; UnknownException; WebserviceException

isAdmin

public boolean isAdmin()
                throws PrincipalAdapterException,
                       UnknownException,
                       WebserviceException

Specified by:: isAdmin in interface BaseAuth
Throws:: PrincipalAdapterException; UnknownException; WebserviceException

hasSecurityRecursive

public boolean hasSecurityRecursive()
                             throws UnknownException,
                                    WebserviceException

Specified by:: hasSecurityRecursive in interface BaseAuth
Throws:: UnknownException; WebserviceException

isLoginLowercase

public boolean isLoginLowercase()
                         throws UnknownException,
                                WebserviceException

Specified by:: isLoginLowercase in interface BaseAuth
Throws:: UnknownException; WebserviceException

isPasswordExpired

public boolean isPasswordExpired()
                          throws UnknownException,
                                 WebserviceException

Specified by:: isPasswordExpired in interface BaseAuth
Throws:: UnknownException; WebserviceException

Class AuthImpl

Constructor Summary

Method Summary

Methods inherited from class com.openkm.sdk4j.impl.ClientImpl

Methods inherited from class java.lang.Object

Constructor Detail

AuthImpl

Method Detail

setAuthorizationToken

login

login

logout

getSessionId

getGrantedUsersAndRoles

getGrantedRoles

getGrantedUsers

getRoles

getRolesByUser

getUsers

getUser

getUsersByRole

revokeRole

revokeUser

grantRole

grantUser

createUser

deleteUser

updateUser

createRole

deleteRole

updateRole

assignRole

removeRole

changeSecurity

getProfiles

getUserProfile

setUserProfile

setUserPermissions

setRolePermissions

getUserTenants

setUserTenant

isAdmin

hasSecurityRecursive

isLoginLowercase

isPasswordExpired