GeoFence (gcube-geofence-library 1.0.0-SNAPSHOT API)

java.lang.Object
- org.gcube.data.access.api.GeoFence

```
public class GeoFence
extends Object
```

Constructor Summary

Constructors
Constructor and Description

GeoFence(String geofenceRestUrl)
Constructor of GeoFence to build the REST API to access on geofence instance.

Constructors
Constructor and Description
`GeoFence(String geofenceRestUrl)` Constructor of GeoFence to build the REST API to access on geofence instance.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.springframework.http.HttpStatus`	`assignToUserGroupByUserIdGroupId(String userId, String groupId)` Returns an HttpStatus (status) when you try to assign the user by id to group by id.
`org.springframework.http.HttpStatus`	`assignToUserGroupByUserIdGroupName(String userId, String groupName)` Returns an HttpStatus (status) when you try to assign the user by id to group by name.
`org.springframework.http.HttpStatus`	`assignToUserGroupByUserNameGroupId(String userName, String groupId)` Returns an HttpStatus (status) when you try to assign the user by username to group by id.
`org.springframework.http.HttpStatus`	`assignToUserGroupByUserNameGroupName(String userName, String groupName)` Returns an HttpStatus (status) when you try to assign the user by username to group by name.
`org.springframework.http.HttpStatus`	`createInstance(Instance instance)` Returns an HttpStatus (status) when you try to create the Instance object.
`org.springframework.http.HttpStatus`	`createRule(Rule rule)` Returns an HttpStatus (status) when you try to create the Rule object.
`org.springframework.http.HttpStatus`	`createUser(User user)` Returns an HttpStatus (status) when you try to create the User object.
`org.springframework.http.HttpStatus`	`createUserGroup(UserGroup userGroup)` Returns an HttpStatus (status) when you try to create the UserGroup object using the UserGroup object.
`org.springframework.http.HttpStatus`	`deleteInstanceById(String instanceId)` Returns an HttpStatus (status) when you try to delete the Instance object using the instanceId.
`org.springframework.http.HttpStatus`	`deleteInstanceByName(String instanceName, boolean removeAllRules)` Returns an HttpStatus (status) when you try to delete the Instance object using the instanceName.
`org.springframework.http.HttpStatus`	`deleteRule(String ruleId)` Returns an HttpStatus (status) when you try to delete the Rule object using the ruleId.
`org.springframework.http.HttpStatus`	`deleteUserById(String id, boolean removeAllRules)` Returns an HttpStatus (status) when you try to delete the User object using the id.
`org.springframework.http.HttpStatus`	`deleteUserByUsername(String userName, boolean removeAllRules)` Returns an HttpStatus (status) when you try to delete the User object using the userName.
`org.springframework.http.HttpStatus`	`deleteUserGroupById(String groupId)` Returns an HttpStatus (status) when you try to delete the Group object using the groupId.
`org.springframework.http.HttpStatus`	`deleteUserGroupByName(String groupName)` Returns an HttpStatus (status) when you try to delete the Group object using the groupName.
`GSInstance`	`getInstanceById(String instanceId)` Returns an GSInstance object using a specific id of instance.
`GSInstance`	`getInstanceByName(String instanceName)` Returns an GSInstance object using a specific name of instance.
`GSInstanceList`	`getInstanceList()` Returns a GSInstanceList object within a list of Instance object.
`Rules`	`getRulesById(String id)` Returns a Rule object using a specific id of rule.
`RuleList`	`getRulesList()` Returns a RuleList object within a list of Rule object.
`GSUser`	`getUserById(String id)` Returns a GeoServer User (GSUser) object using a specific id of user.
`GSUser`	`getUserByUsername(String userName)` Returns a GeoServer User (GSUser) object using a specific name of user.
`Group`	`getUserGroupById(String id)` Returns an Group object using a specific id of user.
`Group`	`getUserGroupByName(String userName)` Returns an Group object using a specific userName of user.
`UserGroupList`	`getUserGroupList()` Returns a UserGroupList object within a list of UserGroups object.
`UserList`	`getUserList()` Returns a UserList object within a list of Users object.
`org.springframework.http.HttpStatus`	`removeUserGroupByUserIdGroupId(String userId, String groupId)` Returns an HttpStatus (status) when you try to remove the user by id and the group by id.
`org.springframework.http.HttpStatus`	`removeUserGroupByUserIdGroupName(String userId, String groupName)` Returns an HttpStatus (status) when you try to remove the user by id and the group by name.
`org.springframework.http.HttpStatus`	`removeUserGroupByUserNameGroupId(String userName, String groupId)` Returns an HttpStatus (status) when you try to remove the user by username and the group by id.
`org.springframework.http.HttpStatus`	`removeUserGroupByUserNameGroupName(String userName, String groupName)` Returns an HttpStatus (status) when you try to remove the user by username and the group by name.
`org.springframework.http.HttpStatus`	`updateInstance(Instance instance)` Returns an HttpStatus (status) when you try to update the Instance object using an instance.
`org.springframework.http.HttpStatus`	`updateInstanceById(String id, String username, String password, String baseURL, String description)` Returns an HttpStatus (status) when you try to update the Instance object with a specific id.
`org.springframework.http.HttpStatus`	`updateInstanceByName(String instanceName, String username, String password, String baseURL, String description)` Returns an HttpStatus (status) when you try to update the Instance object with a specific instanceName.
`org.springframework.http.HttpStatus`	`updateRule(Rule rule)` Returns an HttpStatus (status) when you try to update the Rule object.
`org.springframework.http.HttpStatus`	`updateRuleById(String id, String priority, String service, String request, String workspace, String layer, String userId, String groupId, String instanceId)` Returns an HttpStatus (status) when you try to update the Rule object with a specific id.
`org.springframework.http.HttpStatus`	`updateUser(User user)` Returns an HttpStatus (status) when you try to update the User object.
`org.springframework.http.HttpStatus`	`updateUserById(String id, String password, String email, boolean admin, boolean enabled)` Returns an HttpStatus (status) when you try to update the User object using the id.
`org.springframework.http.HttpStatus`	`updateUserByUsername(String userName, String password, String email, boolean admin, boolean enabled)` Returns an HttpStatus (status) when you try to update the User object using the userName.
`org.springframework.http.HttpStatus`	`updateUserGroup(Group group)` Returns an HttpStatus (status) when you try to update the Group object using a group.
`org.springframework.http.HttpStatus`	`updateUserGroupById(String id, boolean enabled)` Returns an HttpStatus (status) when you try to update the Group object using a group.
`org.springframework.http.HttpStatus`	`updateUserGroupByName(String name, boolean enabled)` Returns an HttpStatus (status) when you try to update the Group object using a name.

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

- Constructor Detail
  - GeoFence
```
public GeoFence(String geofenceRestUrl)
```
    Constructor of GeoFence to build the REST API to access on geofence instance.
    
    Parameters:
    
    geofenceRestUrl - It's the REST API URL of your geofence instance.
- Method Detail
  - getUserById
```
public GSUser getUserById(String id)
```
    Returns a GeoServer User (GSUser) object using a specific id of user.
    
    Parameters:
    
    id - It's the userId of user you are looking for.
    
    Returns:
    
    GSUser object.
  - getUserByUsername
```
public GSUser getUserByUsername(String userName)
```
    Returns a GeoServer User (GSUser) object using a specific name of user.
    
    Parameters:
    
    userName - It's the name of user you are looking for.
    
    Returns:
    
    GSUser object.
  - createUser
```
public org.springframework.http.HttpStatus createUser(User user)
```
    Returns an HttpStatus (status) when you try to create the User object.
    
    Parameters:
    
    user - It's the User object you are creating.
    
    Returns:
    
    HttpStatus object.
  - updateUser
```
public org.springframework.http.HttpStatus updateUser(User user)
```
    Returns an HttpStatus (status) when you try to update the User object.
    
    Parameters:
    
    user - It's the User object you are updating.
    
    Returns:
    
    HttpStatus object.
  - updateUserById
```
public org.springframework.http.HttpStatus updateUserById(String id,
                                                          String password,
                                                          String email,
                                                          boolean admin,
                                                          boolean enabled)
```
    Returns an HttpStatus (status) when you try to update the User object using the id.
    
    Parameters:
    
    id - It's the id of user.
    
    password - It's the password of user.
    
    email - It's the email of user.
    
    admin - It's the boolean flag to define if user is administrator or not.
    
    enabled - It's the boolean flag to define if user is enabled or not.
    
    Returns:
    
    HttpStatus object.
  - updateUserByUsername
```
public org.springframework.http.HttpStatus updateUserByUsername(String userName,
                                                                String password,
                                                                String email,
                                                                boolean admin,
                                                                boolean enabled)
```
    Returns an HttpStatus (status) when you try to update the User object using the userName.
    
    Parameters:
    
    userName - It's the username of user.
    
    password - It's the password of user.
    
    email - It's the email of user.
    
    admin - It's the boolean flag to define if user is administrator or not.
    
    enabled - It's the boolean flag to define if user is enabled or not.
    
    Returns:
    
    HttpStatus object.
  - deleteUserById
```
public org.springframework.http.HttpStatus deleteUserById(String id,
                                                          boolean removeAllRules)
```
    Returns an HttpStatus (status) when you try to delete the User object using the id.
    
    Parameters:
    
    id - It's the id of user.
    
    removeAllRules - It's a flag to remove all rules together to the user.
    
    Returns:
    
    HttpStatus object.
  - deleteUserByUsername
```
public org.springframework.http.HttpStatus deleteUserByUsername(String userName,
                                                                boolean removeAllRules)
```
    Returns an HttpStatus (status) when you try to delete the User object using the userName.
    
    Parameters:
    
    userName - It's the username of user.
    
    removeAllRules - It's a flag to remove all rules together to the user.
    
    Returns:
    
    HttpStatus object.
  - getUserList
```
public UserList getUserList()
```
    Returns a UserList object within a list of Users object.
    
    Returns:
    
    UserList object.
  - createUserGroup
```
public org.springframework.http.HttpStatus createUserGroup(UserGroup userGroup)
```
    Returns an HttpStatus (status) when you try to create the UserGroup object using the UserGroup object.
    
    Parameters:
    
    userGroup - It's the UserGroup object you are creating.
    
    Returns:
    
    HttpStatus object.
  - getUserGroupById
```
public Group getUserGroupById(String id)
```
    Returns an Group object using a specific id of user.
    
    Parameters:
    
    id - It's the id of group you are looking for.
    
    Returns:
    
    Group object.
  - getUserGroupByName
```
public Group getUserGroupByName(String userName)
```
    Returns an Group object using a specific userName of user.
    
    Parameters:
    
    userName - It's the username of group you are looking for.
    
    Returns:
    
    Group object.
  - updateUserGroup
```
public org.springframework.http.HttpStatus updateUserGroup(Group group)
```
    Returns an HttpStatus (status) when you try to update the Group object using a group.
    
    Parameters:
    
    group - It's the Group object you are updating.
    
    Returns:
    
    HttpStatus object.
  - updateUserGroupById
```
public org.springframework.http.HttpStatus updateUserGroupById(String id,
                                                               boolean enabled)
```
    Returns an HttpStatus (status) when you try to update the Group object using a group.
    
    Parameters:
    
    id - It's the id of group you are updating.
    
    enabled - It's the enabled flag of group.
    
    Returns:
    
    HttpStatus object.
  - updateUserGroupByName
```
public org.springframework.http.HttpStatus updateUserGroupByName(String name,
                                                                 boolean enabled)
```
    Returns an HttpStatus (status) when you try to update the Group object using a name.
    
    Parameters:
    
    name - It's the name of Group object you are updating.
    
    enabled - It's the enabled flag of group.
    
    Returns:
    
    HttpStatus object.
  - deleteUserGroupById
```
public org.springframework.http.HttpStatus deleteUserGroupById(String groupId)
```
    Returns an HttpStatus (status) when you try to delete the Group object using the groupId.
    
    Parameters:
    
    groupId - It's the groupId of group.
    
    Returns:
    
    HttpStatus object.
  - deleteUserGroupByName
```
public org.springframework.http.HttpStatus deleteUserGroupByName(String groupName)
```
    Returns an HttpStatus (status) when you try to delete the Group object using the groupName.
    
    Parameters:
    
    groupName - It's the id of group.
    
    Returns:
    
    HttpStatus object.
  - getUserGroupList
```
public UserGroupList getUserGroupList()
```
    Returns a UserGroupList object within a list of UserGroups object.
    
    Returns:
    
    UserGroupList object.
  - assignToUserGroupByUserIdGroupId
```
public org.springframework.http.HttpStatus assignToUserGroupByUserIdGroupId(String userId,
                                                                            String groupId)
```
    Returns an HttpStatus (status) when you try to assign the user by id to group by id.
    
    Parameters:
    
    userId - It's the id of user.
    
    groupId - It's the id of group.
    
    Returns:
    
    HttpStatus object.
  - assignToUserGroupByUserIdGroupName
```
public org.springframework.http.HttpStatus assignToUserGroupByUserIdGroupName(String userId,
                                                                              String groupName)
```
    Returns an HttpStatus (status) when you try to assign the user by id to group by name.
    
    Parameters:
    
    userId - It's the id of user.
    
    groupName - It's the name of group.
    
    Returns:
    
    HttpStatus object.
  - assignToUserGroupByUserNameGroupId
```
public org.springframework.http.HttpStatus assignToUserGroupByUserNameGroupId(String userName,
                                                                              String groupId)
```
    Returns an HttpStatus (status) when you try to assign the user by username to group by id.
    
    Parameters:
    
    userName - It's the username of user.
    
    groupId - It's the id of group.
    
    Returns:
    
    HttpStatus object.
  - assignToUserGroupByUserNameGroupName
```
public org.springframework.http.HttpStatus assignToUserGroupByUserNameGroupName(String userName,
                                                                                String groupName)
```
    Returns an HttpStatus (status) when you try to assign the user by username to group by name.
    
    Parameters:
    
    userName - It's the username of user.
    
    groupName - It's the name of group.
    
    Returns:
    
    HttpStatus object.
  - removeUserGroupByUserIdGroupId
```
public org.springframework.http.HttpStatus removeUserGroupByUserIdGroupId(String userId,
                                                                          String groupId)
```
    Returns an HttpStatus (status) when you try to remove the user by id and the group by id.
    
    Parameters:
    
    userId - It's the id of user.
    
    groupId - It's the id of group.
    
    Returns:
    
    HttpStatus object.
  - removeUserGroupByUserIdGroupName
```
public org.springframework.http.HttpStatus removeUserGroupByUserIdGroupName(String userId,
                                                                            String groupName)
```
    Returns an HttpStatus (status) when you try to remove the user by id and the group by name.
    
    Parameters:
    
    userId - It's the id of user.
    
    groupName - It's the name of group.
    
    Returns:
    
    HttpStatus object.
  - removeUserGroupByUserNameGroupId
```
public org.springframework.http.HttpStatus removeUserGroupByUserNameGroupId(String userName,
                                                                            String groupId)
```
    Returns an HttpStatus (status) when you try to remove the user by username and the group by id.
    
    Parameters:
    
    userName - It's the username of user.
    
    groupId - It's the id of group.
    
    Returns:
    
    HttpStatus object.
  - removeUserGroupByUserNameGroupName
```
public org.springframework.http.HttpStatus removeUserGroupByUserNameGroupName(String userName,
                                                                              String groupName)
```
    Returns an HttpStatus (status) when you try to remove the user by username and the group by name.
    
    Parameters:
    
    userName - It's the username of user.
    
    groupName - It's the name of group.
    
    Returns:
    
    HttpStatus object.
  - createInstance
```
public org.springframework.http.HttpStatus createInstance(Instance instance)
```
    Returns an HttpStatus (status) when you try to create the Instance object.
    
    Parameters:
    
    instance - It's the Instance object.
    
    Returns:
    
    HttpStatus object.
  - getInstanceById
```
public GSInstance getInstanceById(String instanceId)
```
    Returns an GSInstance object using a specific id of instance.
    
    Parameters:
    
    instanceId - It's the id of Instance object.
    
    Returns:
    
    GSInstance object.
  - getInstanceByName
```
public GSInstance getInstanceByName(String instanceName)
```
    Returns an GSInstance object using a specific name of instance.
    
    Parameters:
    
    instanceName - It's the name of Instance object.
    
    Returns:
    
    GSInstance object.
  - updateInstance
```
public org.springframework.http.HttpStatus updateInstance(Instance instance)
```
    Returns an HttpStatus (status) when you try to update the Instance object using an instance.
    
    Parameters:
    
    instance - It's the Instance object.
    
    Returns:
    
    HttpStatus object.
  - updateInstanceById
```
public org.springframework.http.HttpStatus updateInstanceById(String id,
                                                              String username,
                                                              String password,
                                                              String baseURL,
                                                              String description)
```
    Returns an HttpStatus (status) when you try to update the Instance object with a specific id.
    
    Parameters:
    
    id - It's the id of Instance object, not editable.
    
    username - It's the username of Instance object.
    
    password - It's the password of Instance object.
    
    baseURL - It's the baseURL of Instance object.
    
    description - It's the description of Instance object.
    
    Returns:
    
    HttpStatus object.
  - updateInstanceByName
```
public org.springframework.http.HttpStatus updateInstanceByName(String instanceName,
                                                                String username,
                                                                String password,
                                                                String baseURL,
                                                                String description)
```
    Returns an HttpStatus (status) when you try to update the Instance object with a specific instanceName.
    
    Parameters:
    
    instanceName - It's the name of Instance object, not editable.
    
    username - It's the username of Instance object.
    
    password - It's the password of Instance object.
    
    baseURL - It's the baseURL of Instance object.
    
    description - It's the description of Instance object.
    
    Returns:
    
    HttpStatus object.
  - deleteInstanceById
```
public org.springframework.http.HttpStatus deleteInstanceById(String instanceId)
```
    Returns an HttpStatus (status) when you try to delete the Instance object using the instanceId.
    
    Parameters:
    
    instanceId - It's the id of Instance object.
    
    Returns:
    
    HttpStatus object.
  - deleteInstanceByName
```
public org.springframework.http.HttpStatus deleteInstanceByName(String instanceName,
                                                                boolean removeAllRules)
```
    Returns an HttpStatus (status) when you try to delete the Instance object using the instanceName.
    
    Parameters:
    
    instanceName - It's the name of Instance object.
    
    removeAllRules - It's a parameter to removes all rules together the Instance object.
    
    Returns:
    
    HttpStatus object.
  - getInstanceList
```
public GSInstanceList getInstanceList()
```
    Returns a GSInstanceList object within a list of Instance object.
    
    Returns:
    
    GSInstanceList object.
  - createRule
```
public org.springframework.http.HttpStatus createRule(Rule rule)
```
    Returns an HttpStatus (status) when you try to create the Rule object.
    
    Parameters:
    
    rule - It's the Rule object.
    
    Returns:
    
    HttpStatus object.
  - getRulesById
```
public Rules getRulesById(String id)
```
    Returns a Rule object using a specific id of rule.
    
    Parameters:
    
    id - It's the id of rule.
    
    Returns:
    
    Rule object.
  - updateRule
```
public org.springframework.http.HttpStatus updateRule(Rule rule)
```
    Returns an HttpStatus (status) when you try to update the Rule object.
    
    Parameters:
    
    rule - It's the rule object.
    
    Returns:
    
    HttpStatus object.
  - updateRuleById
```
public org.springframework.http.HttpStatus updateRuleById(String id,
                                                          String priority,
                                                          String service,
                                                          String request,
                                                          String workspace,
                                                          String layer,
                                                          String userId,
                                                          String groupId,
                                                          String instanceId)
```
    Returns an HttpStatus (status) when you try to update the Rule object with a specific id.
    
    Parameters:
    
    id - It's the id of Instance object, not editable.
    
    priority - It's the priority of Instance object.
    
    service - It's the service of Instance object.
    
    request - It's the request of Instance object.
    
    workspace - It's the workspace of Instance object.
    
    layer - It's the layer of Instance object.
    
    userId - It's the userId of Instance object (not necessary the username).
    
    groupId - It's the groupId of Instance object (not necessary the name).
    
    instanceId - It's the instanceId of Instance object (not necessary the name of instance).
    
    Returns:
    
    HttpStatus object.
  - deleteRule
```
public org.springframework.http.HttpStatus deleteRule(String ruleId)
```
    Returns an HttpStatus (status) when you try to delete the Rule object using the ruleId.
    
    Parameters:
    
    ruleId - It's the id of Rule object.
    
    Returns:
    
    HttpStatus object.
  - getRulesList
```
public RuleList getRulesList()
```
    Returns a RuleList object within a list of Rule object.
    
    Returns:
    
    RuleList object.

Class GeoFence

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GeoFence

Method Detail

getUserById

getUserByUsername

createUser

updateUser

updateUserById

updateUserByUsername

deleteUserById

deleteUserByUsername

getUserList

createUserGroup

getUserGroupById

getUserGroupByName

updateUserGroup

updateUserGroupById

updateUserGroupByName

deleteUserGroupById

deleteUserGroupByName

getUserGroupList

assignToUserGroupByUserIdGroupId

assignToUserGroupByUserIdGroupName

assignToUserGroupByUserNameGroupId

assignToUserGroupByUserNameGroupName

removeUserGroupByUserIdGroupId

removeUserGroupByUserIdGroupName

removeUserGroupByUserNameGroupId

removeUserGroupByUserNameGroupName

createInstance

getInstanceById

getInstanceByName

updateInstance

updateInstanceById

updateInstanceByName

deleteInstanceById

deleteInstanceByName

getInstanceList

createRule

getRulesById

updateRule

updateRuleById

deleteRule

getRulesList