org.apache.ambari.server.controller.internal

Class RootServiceComponentPropertyProvider

java.lang.Object

org.apache.ambari.server.controller.internal.BaseProvider

org.apache.ambari.server.controller.internal.RootServiceComponentPropertyProvider

All Implemented Interfaces:

PropertyProvider

public class RootServiceComponentPropertyProvider
extends BaseProvider
implements PropertyProvider

RootServiceComponentPropertyProvider is a PropertyProvider implementation providing additional properties for RootServiceComponent resources, like AMBARI_SERVER and AMBARI_AGENT.

This implementation conditionally calculates and returns cipher and JCE details upon request. The Cipher data is cached after the first request for it and held in memory until Ambari is restarted. The user is required to explicitly query for one or both of the following properties (or fields) to get access to the data:

• RootServiceComponents/jce_policy
• RootServiceComponents/ciphers

For example:

• GET /api/v1/services/AMBARI/components/AMBARI_SERVER?fields=RootServiceComponents/ciphers
• GET /api/v1/services/AMBARI/components/AMBARI_SERVER?fields=RootServiceComponents/jce_policy
• GET /api/v1/services/AMBARI/components/AMBARI_SERVER?fields=RootServiceComponents/jce_policy,RootServiceComponents/ciphers

When querying for ciphers the returned data is a listing if installed cipher algorithms and their maximum key lengths. If all maximum key lengths are 2147483647, then the unlimited key JCE policy is installed, else each item will have some smaller value (in bytes).

For example:

 "ciphers" : {
   "sunjce.aes" : 2147483647,
   "sunjce.aeswrap" : 2147483647,
   "sunjce.aeswrap_128" : 2147483647,
   "sunjce.aeswrap_192" : 2147483647,
   "sunjce.aeswrap_256" : 2147483647,
   "sunjce.arcfour" : 2147483647,
   "sunjce.blowfish" : 2147483647,
   ...
 }
 

When querying for the JDC policy, the returned data is a structure with details about the JCE policy - namely whether the unlimited key length policy is installed or not.

For example:

 "jce_policy" : {
   "unlimited_key" : true
 }
 

Field Summary

Fields

Modifier and Type	Field and Description
static String	CIPHER_PROPERTIES_PROPERTY_ID
static String	JCE_POLICY_PROPERTY_ID

Constructor Summary

Constructors

Constructor and Description
RootServiceComponentPropertyProvider() Constructor

Method Summary

Modifier and Type	Method and Description
Set<Resource>	populateResources(Set<Resource> resources, Request request, Predicate predicate) Populate the given set of resource with any properties that this property provider can provide and return a populated set of resources.

Methods inherited from class org.apache.ambari.server.controller.internal.BaseProvider

checkCategory, checkConfigPropertyIds, checkPropertyIds, containsArguments, getCategoryIds, getPropertyIds, getRegexEntry, getRegexGroups, getRequestPropertyIds, isPatternKey, isPropertyCategoryRequested, isPropertyEntryRequested, isPropertyRequested, setResourceProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.ambari.server.controller.spi.PropertyProvider

checkPropertyIds

Field Detail

JCE_POLICY_PROPERTY_ID

public static final String JCE_POLICY_PROPERTY_ID

CIPHER_PROPERTIES_PROPERTY_ID

public static final String CIPHER_PROPERTIES_PROPERTY_ID

Constructor Detail

RootServiceComponentPropertyProvider

public RootServiceComponentPropertyProvider()

Constructor

Method Detail

populateResources

public Set<Resource> populateResources(Set<Resource> resources,
                                       Request request,
                                       Predicate predicate)
                                throws SystemException

Description copied from interface: PropertyProvider

Populate the given set of resource with any properties that this property provider can provide and return a populated set of resources. The provider may drop resources from the original set if it determines that the don't meet the conditions of the predicate.

Specified by:

populateResources in interface PropertyProvider

Parameters:

resources - the resources to be populated

request - the request object which defines the desired set of properties

predicate - the predicate object which filters which resources are returned

Returns:

the populated set of resources

Throws:

SystemException - thrown if resources cannot be populated