CSEnvCache (Oracle Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC))

java.lang.Object
- oracle.stellent.ridc.convenience.usersecurity.impl.CSEnvCache

```
public class CSEnvCache
extends Object
```
Cache of Content Server's GET_ENVIRONMENT service

Field Summary

Fields
Modifier and Type	Field and Description
`protected IdcClient`	`m_idcClient`
`protected IdcContext`	`m_idcContext`
`protected ILog`	`m_log`
`protected CachedDataBinder`	`m_serverEnvBinder`
`protected IServiceCallUtils`	`m_serviceCallUtils`
`protected String`	`m_specialAuthGroups`
`protected long`	`m_timeToLive`
`protected Boolean`	`m_using11gDefaultAcl`
`protected Boolean`	`m_usingAccounts`
`protected Boolean`	`m_usingAcl`
`protected Boolean`	`m_usingAclRoles`
`protected Boolean`	`m_usingAuthorDelete`
`protected Boolean`	`m_usingCollab`
`protected Boolean`	`m_usingOldRIDCAccessModel`

Constructor Summary

Constructors
Constructor and Description
`CSEnvCache(IdcClient idcClient, IdcContext idcContext, long timeToLive)` Deprecated.
`CSEnvCache(IdcClient idcClient, IdcContext idcContext, long timeToLive, IServiceCallUtils serviceCallUtils)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`clearCache()` Clear any cache of information
`IdcClient`	`getIdcClient()`
`protected DataBinder`	`getServerEnvironmentBinder(ITrace trace)` Get the server Environment Binder
`IServiceCallUtils`	`getServiceCallUtils()`
`boolean`	`hasExpired(long timeToLive)` Return true if the TimeToLive for this object has expired
`boolean`	`isAuthorDeleteEnabled(ITrace trace)`
`boolean`	`isCollaborationModel()` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isCollaborationModel(ITrace trace)` Check to see if the server is using Collaboration for Acl Security
`boolean`	`isInSpecialAuthGroups(String dSecurityGroup)` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isInSpecialAuthGroups(String dSecurityGroup, ITrace trace)` Check to see if dSecurityGroup is covered by ACL
`boolean`	`isUsing11gDefaultAcl()` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isUsing11gDefaultAcl(ITrace trace)` Check to see which default ACL algorithm to use
`boolean`	`isUsingAccounts()` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isUsingAccounts(ITrace trace)` Check to see if the server is using Accounts security
`boolean`	`isUsingAcl()` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isUsingAcl(ITrace trace)` Check to see if the server is using Acl security
`boolean`	`isUsingAclRoles()` Deprecated. this method swallows IdcClientExceptions
`boolean`	`isUsingAclRoles(ITrace trace)` Check to see if server is using the RoleEntityACL feature

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

Field Detail

m_log
```
protected ILog m_log
```

m_idcClient
```
protected IdcClient m_idcClient
```

m_idcContext
```
protected IdcContext m_idcContext
```

m_serverEnvBinder

protected CachedDataBinder m_serverEnvBinder

m_timeToLive
```
protected long m_timeToLive
```

m_usingAccounts
```
protected Boolean m_usingAccounts
```

m_usingAcl
```
protected Boolean m_usingAcl
```

m_usingCollab
```
protected Boolean m_usingCollab
```

m_using11gDefaultAcl
```
protected Boolean m_using11gDefaultAcl
```

m_usingAclRoles
```
protected Boolean m_usingAclRoles
```

m_usingOldRIDCAccessModel

protected Boolean m_usingOldRIDCAccessModel

m_usingAuthorDelete
```
protected Boolean m_usingAuthorDelete
```

m_specialAuthGroups
```
protected String m_specialAuthGroups
```

m_serviceCallUtils

protected IServiceCallUtils m_serviceCallUtils

Constructor Detail

CSEnvCache

@Deprecated
public CSEnvCache(IdcClient idcClient,
                              IdcContext idcContext,
                              long timeToLive)

Deprecated.

CSEnvCache

public CSEnvCache(IdcClient idcClient,
                  IdcContext idcContext,
                  long timeToLive,
                  IServiceCallUtils serviceCallUtils)

Method Detail
- clearCache
```
public void clearCache()
```
  Clear any cache of information
- getServiceCallUtils
```
public IServiceCallUtils getServiceCallUtils()
```
- hasExpired
```
public boolean hasExpired(long timeToLive)
```
  Return true if the TimeToLive for this object has expired
  
  Parameters:
  
  timeToLive - in milliseconds
  
  Returns:
- getIdcClient
```
public IdcClient getIdcClient()
```
- getServerEnvironmentBinder
```
protected DataBinder getServerEnvironmentBinder(ITrace trace)
                                         throws IdcClientException
```
  Get the server Environment Binder
  
  Returns:
  
  Server's environment via a Service Call (when cache expires)
  
  Throws:
  
  IdcClientException
- isAuthorDeleteEnabled
```
public boolean isAuthorDeleteEnabled(ITrace trace)
                              throws IdcClientException
```
  Throws:
  
  IdcClientException
- isUsingAccounts
```
public boolean isUsingAccounts()
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see if the server is using Accounts security
- isUsingAccounts
```
public boolean isUsingAccounts(ITrace trace)
                        throws IdcClientException
```
  Check to see if the server is using Accounts security
  
  Parameters:
  
  trace -
  
  Throws:
  
  IdcClientException
- isUsingAcl
```
public boolean isUsingAcl()
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see if the server is using Acl security
- isUsingAcl
```
public boolean isUsingAcl(ITrace trace)
                   throws IdcClientException
```
  Check to see if the server is using Acl security
  
  Parameters:
  
  trace -
  
  Throws:
  
  IdcClientException
- isCollaborationModel
```
public boolean isCollaborationModel()
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see if the server is using Collaboration for Acl Security
- isCollaborationModel
```
public boolean isCollaborationModel(ITrace trace)
                             throws IdcClientException
```
  Check to see if the server is using Collaboration for Acl Security
  
  Parameters:
  
  trace -
  
  Throws:
  
  IdcClientException
- isUsingAclRoles
```
public boolean isUsingAclRoles()
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see if server is using the RoleEntityACL feature
- isUsingAclRoles
```
public boolean isUsingAclRoles(ITrace trace)
                        throws IdcClientException
```
  Check to see if server is using the RoleEntityACL feature
  
  Parameters:
  
  trace -
  
  Throws:
  
  IdcClientException
- isUsing11gDefaultAcl
```
public boolean isUsing11gDefaultAcl()
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see which default ACL algorithm to use
- isUsing11gDefaultAcl
```
public boolean isUsing11gDefaultAcl(ITrace trace)
                             throws IdcClientException
```
  Check to see which default ACL algorithm to use
  
  Parameters:
  
  trace -
  
  Throws:
  
  IdcClientException
- isInSpecialAuthGroups
```
public boolean isInSpecialAuthGroups(String dSecurityGroup)
```
  Deprecated. this method swallows IdcClientExceptions
  
  Check to see if dSecurityGroup is covered by ACL
  
  Parameters:
  
  dSecurityGroup - of the document
- isInSpecialAuthGroups
```
public boolean isInSpecialAuthGroups(String dSecurityGroup,
                                     ITrace trace)
                              throws IdcClientException
```
  Check to see if dSecurityGroup is covered by ACL
  
  Parameters:
  
  dSecurityGroup - of the document
  
  Throws:
  
  IdcClientException

Class CSEnvCache

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

m_log

m_idcClient

m_idcContext

m_serverEnvBinder

m_timeToLive

m_usingAccounts

m_usingAcl

m_usingCollab

m_using11gDefaultAcl

m_usingAclRoles

m_usingOldRIDCAccessModel

m_usingAuthorDelete

m_specialAuthGroups

m_serviceCallUtils

Constructor Detail

CSEnvCache

CSEnvCache

Method Detail

clearCache

getServiceCallUtils

hasExpired

getIdcClient

getServerEnvironmentBinder

isAuthorDeleteEnabled

isUsingAccounts

isUsingAccounts

isUsingAcl

isUsingAcl

isCollaborationModel

isCollaborationModel

isUsingAclRoles

isUsingAclRoles

isUsing11gDefaultAcl

isUsing11gDefaultAcl

isInSpecialAuthGroups

isInSpecialAuthGroups