Package org.opensaml.core.xml.config
Class XMLObjectProviderRegistrySupport
- java.lang.Object
-
- org.opensaml.core.xml.config.XMLObjectProviderRegistrySupport
-
public class XMLObjectProviderRegistrySupport extends Object
Class for loading library configuration files and retrieving the configured components.
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
XMLObjectProviderRegistrySupport()
Constructor.
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method Description static void
deregisterIDAttribute(QName attributeName)
Deregister an attribute as having a type of ID.static void
deregisterObjectProvider(QName key)
Removes the builder, marshaller, and unmarshaller registered to the given key.static XMLObjectBuilderFactory
getBuilderFactory()
Gets the XMLObject builder factory that has been configured with information from loaded configuration files.static QName
getDefaultProviderQName()
Gets the QName for the object provider that will be used for XMLObjects that do not have a registered object provider.static MarshallerFactory
getMarshallerFactory()
Gets the XMLObject marshaller factory that has been configured with information from loaded configuration files.static ParserPool
getParserPool()
Get the currently configured ParserPool instance.static UnmarshallerFactory
getUnmarshallerFactory()
Gets the XMLObject unmarshaller factory that has been configured with information from loaded configuration files.static boolean
isIDAttribute(QName attributeName)
Determine whether a given attribute is registered as having an ID type.static void
registerIDAttribute(QName attributeName)
Register an attribute as having a type of ID.static void
registerObjectProvider(QName providerName, XMLObjectBuilder<?> builder, Marshaller marshaller, Unmarshaller unmarshaller)
Adds an object provider to this configuration.static void
setParserPool(ParserPool newParserPool)
Set the currently configured ParserPool instance.
-
-
-
Method Detail
-
getParserPool
@Nullable public static ParserPool getParserPool()
Get the currently configured ParserPool instance.- Returns:
- the currently ParserPool
-
setParserPool
public static void setParserPool(@Nullable ParserPool newParserPool)
Set the currently configured ParserPool instance.- Parameters:
newParserPool
- the new ParserPool instance to configure
-
getDefaultProviderQName
public static QName getDefaultProviderQName()
Gets the QName for the object provider that will be used for XMLObjects that do not have a registered object provider.- Returns:
- the QName for the default object provider
-
registerObjectProvider
public static void registerObjectProvider(@Nonnull QName providerName, @Nonnull XMLObjectBuilder<?> builder, @Nonnull Marshaller marshaller, @Nonnull Unmarshaller unmarshaller)
Adds an object provider to this configuration.- Parameters:
providerName
- the name of the object provider, corresponding to the element name or type name that the builder, marshaller, and unmarshaller operate onbuilder
- the builder for that given providermarshaller
- the marshaller for the providerunmarshaller
- the unmarshaller for the provider
-
deregisterObjectProvider
public static void deregisterObjectProvider(@Nonnull QName key)
Removes the builder, marshaller, and unmarshaller registered to the given key.- Parameters:
key
- the key of the builder, marshaller, and unmarshaller to be removed
-
getBuilderFactory
public static XMLObjectBuilderFactory getBuilderFactory()
Gets the XMLObject builder factory that has been configured with information from loaded configuration files.- Returns:
- the XMLObject builder factory
-
getMarshallerFactory
public static MarshallerFactory getMarshallerFactory()
Gets the XMLObject marshaller factory that has been configured with information from loaded configuration files.- Returns:
- the XMLObject marshaller factory
-
getUnmarshallerFactory
public static UnmarshallerFactory getUnmarshallerFactory()
Gets the XMLObject unmarshaller factory that has been configured with information from loaded configuration files.- Returns:
- the XMLObject unmarshaller factory
-
registerIDAttribute
public static void registerIDAttribute(QName attributeName)
Register an attribute as having a type of ID.- Parameters:
attributeName
- the QName of the ID attribute to be registered
-
deregisterIDAttribute
public static void deregisterIDAttribute(QName attributeName)
Deregister an attribute as having a type of ID.- Parameters:
attributeName
- the QName of the ID attribute to be de-registered
-
isIDAttribute
public static boolean isIDAttribute(QName attributeName)
Determine whether a given attribute is registered as having an ID type.- Parameters:
attributeName
- the QName of the attribute to be checked for ID type.- Returns:
- true if attribute is registered as having an ID type.
-
-