java.lang.Object
- org.cyclos.impl.AbstractServerComponent
- - org.cyclos.impl.AbstractNetworkedServerComponent

Direct Known Subclasses:

BaseNetworkedHandlerImpl, BaseServiceImpl, BaseServiceSecurity
```
public class AbstractNetworkedServerComponent
extends AbstractServerComponent
```
Base class for server components which operates with the network concept

Field Summary

Fields
Modifier and Type	Field	Description
`protected AuthHandler`	`authHandler`
`protected ConversionHandler`	`conversionHandler`
`protected CustomFieldValueHandler`	`customFieldValueHandler`
`protected EntityManagerHandler`	`entityManagerHandler`
`protected GroupsHandler`	`groupsHandler`
`protected ProductsHandler`	`productsHandler`
`protected RestBeanPropertyMapping`	`restBeanPropertyMapping`
`protected UserLocatorHandler`	`userLocatorHandler`

Fields inherited from class org.cyclos.impl.AbstractServerComponent
accountHandler, configurationHandler, dataTranslationHandler, notificationHandler, profileFieldHandler, transactionHandler, translationHandler

Constructor Summary

Constructors
Constructor Description

AbstractNetworkedServerComponent()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`canManage(BasicUser user)`	Returns whether the logged user manages the given user
`protected BasicUser`	`checkManagesUser(BasicUser user)`	Ensures that the logged user can manage the given user
`protected void`	`checkPermission(Permission... permissions)`	Using `hasPermission(Permission...)`, throws an exception when none of the given permissions are granted to the logged user
`protected BasicUser`	`checkRelatesToUser(BasicUser user)`	Ensures that the logged user is related to the given user
`protected void`	`checkValue(Permission permission, Object... values)`	Throws a `PermissionDeniedException` if `hasValue(Permission, Object...)` returns false
`protected void`	`clearAlreadyValidated(Bean bean)`	Forces the given bean as being in the not already validated state
`protected EntityManagerHandler`	`getBaseEntityManagerHandler()`
`protected ConfigurationAccessor`	`getConfiguration()`
`protected BasicUser`	`getLoggedBasicUser()`	Returns the currently logged basic user, being a regular user or operator, or null when none
`protected User`	`getLoggedUser()`	Returns the currently logged user, or the owner user when there's a logged operator, or null when none
`protected ProductsAccessor`	`getProducts()`
`protected String`	`getTranslatedName(NamedEntity entity)`	Returns the translated name for the given entity, according to the current data translation setting
`protected String`	`getTranslatedValue(BaseEntity entity, com.querydsl.core.types.dsl.StringPath property)`	Returns a translated property value for the given entity, according to the current data translation setting
`protected boolean`	`hasPermission(Permission... permissions)`	Checks whether the logged user has access to any of the specified permissions
`protected boolean`	`hasValue(Permission permission, Object... values)`	Returns whether the logged user has access to ALL the given values for the given permission.
`protected boolean`	`inSameNetwork(NetworkedEntity entity)`	Returns whether the given entity is defined on the same network as the current session, or global if the current session is global.
`protected boolean`	`inSameNetworkOrGlobal(NetworkedEntity entity)`	Returns whether the given entity is global (network is null) or is defined on the same network as the current session, or global if the current session is global.
`protected boolean`	`isAdmin()`	Checks whether there's a logged admin
`protected boolean`	`isAlreadyValidated(Bean bean)`	Returns whether the given bean was marked as already validated in this request
`protected boolean`	`isBroker()`	Checks whether there's a logged broker
`protected boolean`	`isGlobalAdmin()`	Returns whether there's a logged global admin
`protected boolean`	`isGlobalAdminInNetwork()`	Returns whether a global admin OR a global restricted has switched to a network.
`protected boolean`	`isGuest()`	Checks whether there's no one logged in, and is a public access
`protected boolean`	`isLoggedIn()`	Checks whether there's a logged user, no matter the user type
`protected boolean`	`isMember()`	Checks whether there's a logged member
`protected boolean`	`isMemberOnly()`	Checks whether there's a logged member only (i.e just member, not broker nor operator)
`protected boolean`	`isNetworkAdmin()`	Returns whether there's a logged network admin
`protected boolean`	`isOperator()`	Checks whether there's a logged operator
`protected boolean`	`isRelatedToUser(BasicUser user)`	Returns whether the logged user is related to the given user
`protected boolean`	`isSystem()`	Checks whether the current thread is running from a system task
`protected boolean`	`isUserManager()`	Returns whether the logged user is a user manager (admin or broker)
`protected boolean`	`isUserManagerOf(BasicUser user)`	Returns true if the logged user is a user manager of the given user.
`protected String`	`message(MessageFormat messageFormat, MessageKey key, Object... arguments)`
`protected String`	`message(MessageKey key, Object... arguments)`
`protected UserPermissionCheck`	`permission(BasicUser user)`
`protected PermissionCheck`	`permission(Permission permission)`
`protected UserPermissionCheck`	`permissionOptionalValue(User user)`
`protected PermissionCheck`	`permissionOptionalValue(Permission permission)`
`protected void`	`setAlreadyValidated(Bean bean, boolean alreadyValidated)`
`protected Date`	`toDate(DateTime dateTime)`	Converts a `DateTime` representing a date in the logged user's time zone to a `Date` delegating to the conversion handler.
`protected DateTime`	`toDateTime(Date date)`	Converts a `Date` to a `DateTime` using the logged user's time zone delegating to the conversion handler.
`protected void`	`validate(Validator validator, Object object)`	Invokes the `Validator#validate(TranslationMessageServiceLocal, ConversionHandler, EntityManager, Object)` method with the current context

Methods inherited from class org.cyclos.impl.AbstractServerComponent
dataTranslationProxy, dataTranslationProxy, delete, detach, doDataTranslationProxy, find, flush, from, getApplicationContext, getFormatter, getFormatter, getFormatter, getLogger, getRemoteAddress, getSessionData, mailContentBuilder, message, message, persist, processBatch, processBatch, refresh, remove, selectFrom, subQuery, update

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

- Field Detail
  - entityManagerHandler
```
@Autowired
protected EntityManagerHandler entityManagerHandler
```
  - productsHandler
```
@Autowired
protected ProductsHandler productsHandler
```
  - groupsHandler
```
@Autowired
protected GroupsHandler groupsHandler
```
  - userLocatorHandler
```
@Autowired
protected UserLocatorHandler userLocatorHandler
```
  - conversionHandler
```
@Autowired
protected ConversionHandler conversionHandler
```
  - customFieldValueHandler
```
@Autowired
protected CustomFieldValueHandler customFieldValueHandler
```
  - authHandler
```
@Autowired
protected AuthHandler authHandler
```
  - restBeanPropertyMapping
```
@Autowired
protected RestBeanPropertyMapping restBeanPropertyMapping
```
- Constructor Detail
  - AbstractNetworkedServerComponent
```
public AbstractNetworkedServerComponent()
```
- Method Detail
  - canManage
```
protected boolean canManage(BasicUser user)
```
    Returns whether the logged user manages the given user
  - checkManagesUser
```
protected BasicUser checkManagesUser(BasicUser user)
                              throws PermissionDeniedException
```
    Ensures that the logged user can manage the given user
    
    Throws:
    
    PermissionDeniedException
  - checkPermission
```
protected void checkPermission(Permission... permissions)
                        throws PermissionDeniedException
```
    Using hasPermission(Permission...), throws an exception when none of the given permissions are granted to the logged user
    
    Throws:
    
    PermissionDeniedException
  - checkRelatesToUser
```
protected BasicUser checkRelatesToUser(BasicUser user)
                                throws PermissionDeniedException
```
    Ensures that the logged user is related to the given user
    
    Throws:
    
    PermissionDeniedException
  - checkValue
```
protected void checkValue(Permission permission,
                          Object... values)
                   throws PermissionDeniedException
```
    Throws a PermissionDeniedException if hasValue(Permission, Object...) returns false
    
    Throws:
    
    PermissionDeniedException
  - clearAlreadyValidated
```
protected void clearAlreadyValidated(Bean bean)
```
    Forces the given bean as being in the not already validated state
  - getBaseEntityManagerHandler
```
protected EntityManagerHandler getBaseEntityManagerHandler()
```
    Specified by:
    
    getBaseEntityManagerHandler in class AbstractServerComponent
  - getConfiguration
```
protected ConfigurationAccessor getConfiguration()
```
  - getLoggedBasicUser
```
protected BasicUser getLoggedBasicUser()
```
    Returns the currently logged basic user, being a regular user or operator, or null when none
  - getLoggedUser
```
protected User getLoggedUser()
```
    Returns the currently logged user, or the owner user when there's a logged operator, or null when none
  - getProducts
```
protected ProductsAccessor getProducts()
```
  - getTranslatedName
```
protected String getTranslatedName(NamedEntity entity)
```
    Returns the translated name for the given entity, according to the current data translation setting
  - getTranslatedValue
```
protected String getTranslatedValue(BaseEntity entity,
                                    com.querydsl.core.types.dsl.StringPath property)
```
    Returns a translated property value for the given entity, according to the current data translation setting
  - hasPermission
```
protected boolean hasPermission(Permission... permissions)
```
    Checks whether the logged user has access to any of the specified permissions
  - hasValue
```
protected boolean hasValue(Permission permission,
                           Object... values)
```
    Returns whether the logged user has access to ALL the given values for the given permission. If the permission is not related to values, returns false
  - inSameNetwork
```
protected boolean inSameNetwork(NetworkedEntity entity)
```
    Returns whether the given entity is defined on the same network as the current session, or global if the current session is global. If running as system, always returns true.
  - inSameNetworkOrGlobal
```
protected boolean inSameNetworkOrGlobal(NetworkedEntity entity)
```
    Returns whether the given entity is global (network is null) or is defined on the same network as the current session, or global if the current session is global. If running as system, always returns true.
  - isAdmin
```
protected boolean isAdmin()
```
    Checks whether there's a logged admin
  - isAlreadyValidated
```
protected boolean isAlreadyValidated(Bean bean)
```
    Returns whether the given bean was marked as already validated in this request
  - isBroker
```
protected boolean isBroker()
```
    Checks whether there's a logged broker
  - isGlobalAdmin
```
protected boolean isGlobalAdmin()
```
    Returns whether there's a logged global admin
  - isGlobalAdminInNetwork
```
protected boolean isGlobalAdminInNetwork()
```
    Returns whether a global admin OR a global restricted has switched to a network.
  - isGuest
```
protected boolean isGuest()
```
    Checks whether there's no one logged in, and is a public access
  - isLoggedIn
```
protected boolean isLoggedIn()
```
    Checks whether there's a logged user, no matter the user type
  - isMember
```
protected boolean isMember()
```
    Checks whether there's a logged member
  - isMemberOnly
```
protected boolean isMemberOnly()
```
    Checks whether there's a logged member only (i.e just member, not broker nor operator)
  - isNetworkAdmin
```
protected boolean isNetworkAdmin()
```
    Returns whether there's a logged network admin
  - isOperator
```
protected boolean isOperator()
```
    Checks whether there's a logged operator
  - isRelatedToUser
```
protected boolean isRelatedToUser(BasicUser user)
```
    Returns whether the logged user is related to the given user
  - isSystem
```
protected boolean isSystem()
```
    Checks whether the current thread is running from a system task
  - isUserManager
```
protected boolean isUserManager()
```
    Returns whether the logged user is a user manager (admin or broker)
  - isUserManagerOf
```
protected boolean isUserManagerOf(BasicUser user)
```
    Returns true if the logged user is a user manager of the given user. Note: A user cannot be a user manager of itself.
  - message
```
protected String message(MessageFormat messageFormat,
                         MessageKey key,
                         Object... arguments)
```
  - message
```
protected String message(MessageKey key,
                         Object... arguments)
```
  - permission
```
protected UserPermissionCheck permission(BasicUser user)
```
    See Also:
    
    AuthHandler#permission(User)
  - permission
```
protected PermissionCheck permission(Permission permission)
```
    See Also:
    
    AuthHandler.permission(Permission)
  - permissionOptionalValue
```
protected PermissionCheck permissionOptionalValue(Permission permission)
```
    See Also:
    
    AuthHandler.permissionOptionalValue(Permission)
  - permissionOptionalValue
```
protected UserPermissionCheck permissionOptionalValue(User user)
```
    See Also:
    
    AuthHandler#permissionOptionalValue(User)
  - setAlreadyValidated
```
protected void setAlreadyValidated(Bean bean,
                                   boolean alreadyValidated)
```
  - toDate
```
protected Date toDate(DateTime dateTime)
```
    Converts a DateTime representing a date in the logged user's time zone to a Date delegating to the conversion handler.
  - toDateTime
```
protected DateTime toDateTime(Date date)
```
    Converts a Date to a DateTime using the logged user's time zone delegating to the conversion handler.
  - validate
```
protected void validate(Validator validator,
                        Object object)
```
    Invokes the Validator#validate(TranslationMessageServiceLocal, ConversionHandler, EntityManager, Object) method with the current context

Class AbstractNetworkedServerComponent

Field Summary

Fields inherited from class org.cyclos.impl.AbstractServerComponent

Constructor Summary

Method Summary

Methods inherited from class org.cyclos.impl.AbstractServerComponent

Methods inherited from class java.lang.Object

Field Detail

entityManagerHandler

productsHandler

groupsHandler

userLocatorHandler

conversionHandler

customFieldValueHandler

authHandler

restBeanPropertyMapping

Constructor Detail

AbstractNetworkedServerComponent

Method Detail

canManage

checkManagesUser

checkPermission

checkRelatesToUser

checkValue

clearAlreadyValidated

getBaseEntityManagerHandler

getConfiguration

getLoggedBasicUser

getLoggedUser

getProducts

getTranslatedName

getTranslatedValue

hasPermission

hasValue

inSameNetwork

inSameNetworkOrGlobal

isAdmin

isAlreadyValidated

isBroker

isGlobalAdmin

isGlobalAdminInNetwork

isGuest

isLoggedIn

isMember

isMemberOnly

isNetworkAdmin

isOperator

isRelatedToUser

isSystem

isUserManager

isUserManagerOf

message

message

permission

permission

permissionOptionalValue

permissionOptionalValue

setAlreadyValidated

toDate

toDateTime

validate