com.evolveum.midpoint.prism

Class PrismContext

java.lang.Object

com.evolveum.midpoint.prism.PrismContext

public class PrismContext
extends Object

Author:

semancik

Field Summary

Fields

Modifier and Type	Field and Description
static String	LANG_JSON
static String	LANG_XML
static String	LANG_YAML

Method Summary

Methods

Modifier and Type	Method and Description
<C extends Containerable,O extends Objectable> void	adopt(C containerable, Class<O> type, ItemPath path)
void	adopt(Containerable containerable)
void	adopt(Objectable objectable)
<T extends Objectable> void	adopt(ObjectDelta<T> delta)
void	adopt(PrismContainerValue value)
<C extends Containerable,O extends Objectable> void	adopt(PrismContainerValue<C> prismContainerValue, Class<O> type, ItemPath path)
<C extends Containerable,O extends Objectable> void	adopt(PrismContainerValue<C> prismContainerValue, QName typeName, ItemPath path)
<T extends Objectable> void	adopt(PrismObject<T> object)
<T extends Objectable> void	adopt(PrismObject<T> object, Class<T> declaredType) Set up the specified object with prism context instance and schema definition.
boolean	canSerialize(Object value)
static PrismContext	create(SchemaRegistry schemaRegistry)
static PrismContext	createEmptyContext(SchemaRegistry schemaRegistry)
<T extends Objectable> PrismObject<T>	createObject(Class<T> clazz)
<T extends Objectable> T	createObjectable(Class<T> clazz)
PrismBeanConverter	getBeanConverter()
PolyStringNormalizer	getDefaultPolyStringNormalizer()
Protector	getDefaultProtector()
SchemaDefinitionFactory	getDefinitionFactory()
JaxbDomHack	getJaxbDomHack()
DomParser	getParserDom() WARNING! This is not really public method.
SchemaRegistry	getSchemaRegistry()
XNodeProcessor	getXnodeProcessor()
void	initialize()
static boolean	isAllowSchemalessSerialization()
protected ParsingContext	newParsingContext()
Object	parseAnyData(File file)
Object	parseAnyData(String dataString, String language) Parses (almost) anything: either an item with a definition, or an atomic (i.e.
<T> T	parseAnyValue(Element element)
<T> T	parseAnyValue(File file) Emulates JAXB unmarshal method.
<T> T	parseAnyValue(InputStream inputStream, String language)
<T> T	parseAnyValue(String dataString, String language)
<T> JAXBElement<T>	parseAnyValueAsJAXBElement(String dataString, String language)
<T> T	parseAtomicValue(File file, QName typeName)
<T> T	parseAtomicValue(File file, QName typeName, String language)
<T> T	parseAtomicValue(String dataString, QName typeName)
<T> T	parseAtomicValue(String dataString, QName typeName, String language) Parses an atomic value - i.e.
<C extends Containerable> PrismContainer<C>	parseContainer(File file, Class<C> type, String language)
<C extends Containerable> PrismContainer<C>	parseContainer(File file, PrismContainerDefinition<C> containerDef, String language)
<C extends Containerable> PrismContainer<C>	parseContainer(String dataString, Class<C> type, String language)
<C extends Containerable> PrismContainer<C>	parseContainer(String dataString, PrismContainerDefinition<C> containerDef, String language)
<C extends Containerable> PrismContainer<C>	parseContainer(String dataString, String language) Parses prism container, trying to autodetect the definition from the root node name (if present) or from node type.
<T extends Objectable> PrismObject<T>	parseObject(Element objectElement) Deprecated.
<T extends Objectable> PrismObject<T>	parseObject(File file) Parses a file and creates a prism from it.
<T extends Objectable> PrismObject<T>	parseObject(File file, ParsingContext context)
<T extends Objectable> PrismObject<T>	parseObject(File file, String language) Parses a file and creates a prism from it.
<T extends Objectable> PrismObject<T>	parseObject(InputStream stream, String language) Parses data from an input stream and creates a prism from it.
<T extends Objectable> PrismObject<T>	parseObject(String dataString) Parses a string and creates a prism from it.
<T extends Objectable> PrismObject<T>	parseObject(String dataString, ParsingContext parsingContext)
<T extends Objectable> PrismObject<T>	parseObject(String dataString, String language) Parses a string and creates a prism from it.
<T extends Objectable> PrismObject<T>	parseObject(String dataString, XNodeProcessorEvaluationMode mode) Parses a string and creates a prism from it.
List<PrismObject<? extends Objectable>>	parseObjects(File file)
Collection<XNode>	parseObjects(InputStream stream, String language)
XNode	parseToXNode(String dataString, String language)
String	serializeAnyData(Object object, QName defaultRootElementName, String language)
String	serializeAnyData(Object object, String language) Serializes any data - i.e.
Element	serializeAnyDataToElement(Object object, QName defaultRootElementName)
Element	serializeAnyDataToElement(Object object, QName defaultRootElementName, SerializationContext ctx)
String	serializeAtomicValue(JAXBElement<?> element, String language)
String	serializeAtomicValue(Object value, QName elementName, String language) Serializes an atomic value - i.e.
String	serializeAtomicValue(Object value, QName elementName, String language, SerializationOptions serializationOptions)
<C extends Containerable> String	serializeContainerValueToString(PrismContainerValue<C> cval, QName elementName, String language)
<O extends Objectable> String	serializeObjectToString(PrismObject<O> object, String language)
<O extends Objectable> Element	serializeToDom(PrismObject<O> object) Deprecated.
Element	serializeValueToDom(PrismValue pval, QName elementName) Deprecated.
Element	serializeValueToDom(PrismValue pval, QName elementName, Document document) Deprecated.
String	serializeXNodeToString(RootXNode xroot, String language)
static void	setAllowSchemalessSerialization(boolean allowSchemalessSerialization)
void	setDefaultPolyStringNormalizer(PolyStringNormalizer defaultPolyStringNormalizer)
void	setDefaultProtector(Protector defaultProtector)
void	setDefinitionFactory(SchemaDefinitionFactory definitionFactory)
void	setSchemaRegistry(SchemaRegistry schemaRegistry)
RawType	toRawType(Item item) A bit of hack: serializes any Item into a RawType.

Methods inherited from class java.lang.Object

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

Field Detail

LANG_XML

public static final String LANG_XML

See Also:

Constant Field Values

LANG_JSON

public static final String LANG_JSON

See Also:

Constant Field Values

LANG_YAML

public static final String LANG_YAML

See Also:

Constant Field Values

Method Detail

create

public static PrismContext create(SchemaRegistry schemaRegistry)

createEmptyContext

public static PrismContext createEmptyContext(SchemaRegistry schemaRegistry)

initialize

public void initialize()
                throws SchemaException,
                       SAXException,
                       IOException

Throws:

SchemaException

SAXException

IOException

isAllowSchemalessSerialization

public static boolean isAllowSchemalessSerialization()

setAllowSchemalessSerialization

public static void setAllowSchemalessSerialization(boolean allowSchemalessSerialization)

getSchemaRegistry

public SchemaRegistry getSchemaRegistry()

setSchemaRegistry

public void setSchemaRegistry(SchemaRegistry schemaRegistry)

getXnodeProcessor

public XNodeProcessor getXnodeProcessor()

getParserDom

public DomParser getParserDom()

WARNING! This is not really public method. It should NOT not used outside the prism implementation.

getBeanConverter

public PrismBeanConverter getBeanConverter()

getJaxbDomHack

public JaxbDomHack getJaxbDomHack()

getDefinitionFactory

public SchemaDefinitionFactory getDefinitionFactory()

setDefinitionFactory

public void setDefinitionFactory(SchemaDefinitionFactory definitionFactory)

getDefaultPolyStringNormalizer

public PolyStringNormalizer getDefaultPolyStringNormalizer()

setDefaultPolyStringNormalizer

public void setDefaultPolyStringNormalizer(PolyStringNormalizer defaultPolyStringNormalizer)

getDefaultProtector

public Protector getDefaultProtector()

setDefaultProtector

public void setDefaultProtector(Protector defaultProtector)

parseObject

public <T extends Objectable> PrismObject<T> parseObject(File file)
                                              throws SchemaException,
                                                     IOException

Parses a file and creates a prism from it. Autodetect language.

Throws:

IOException

SchemaException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(File file,
                                                ParsingContext context)
                                              throws SchemaException,
                                                     IOException

Throws:

SchemaException

IOException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(File file,
                                                String language)
                                              throws SchemaException,
                                                     IOException

Parses a file and creates a prism from it.

Throws:

SchemaException

IOException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(InputStream stream,
                                                String language)
                                              throws SchemaException,
                                                     IOException

Parses data from an input stream and creates a prism from it.

Throws:

SchemaException

IOException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(String dataString)
                                              throws SchemaException

Parses a string and creates a prism from it. Autodetect language. Used mostly for testing, but can also be used for built-in editors, etc.

Throws:

SchemaException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(String dataString,
                                                XNodeProcessorEvaluationMode mode)
                                              throws SchemaException

Parses a string and creates a prism from it. Autodetect language. Used mostly for testing, but can also be used for built-in editors, etc.

Throws:

SchemaException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(String dataString,
                                                ParsingContext parsingContext)
                                              throws SchemaException

Throws:

SchemaException

parseObject

public <T extends Objectable> PrismObject<T> parseObject(String dataString,
                                                String language)
                                              throws SchemaException

Parses a string and creates a prism from it. Used mostly for testing, but can also be used for built-in editors, etc.

Throws:

SchemaException

parseObject

@Deprecated
public <T extends Objectable> PrismObject<T> parseObject(Element objectElement)
                                              throws SchemaException

Deprecated.

Parses a DOM object and creates a prism from it.

Throws:

SchemaException

parseObjects

public List<PrismObject<? extends Objectable>> parseObjects(File file)
                                                     throws SchemaException,
                                                            IOException

Throws:

SchemaException

IOException

parseObjects

public Collection<XNode> parseObjects(InputStream stream,
                             String language)
                               throws SchemaException,
                                      IOException

Throws:

SchemaException

IOException

parseContainer

public <C extends Containerable> PrismContainer<C> parseContainer(File file,
                                                         Class<C> type,
                                                         String language)
                                                       throws SchemaException,
                                                              IOException

Throws:

SchemaException

IOException

parseContainer

public <C extends Containerable> PrismContainer<C> parseContainer(File file,
                                                         PrismContainerDefinition<C> containerDef,
                                                         String language)
                                                       throws SchemaException,
                                                              IOException

Throws:

SchemaException

IOException

parseContainer

public <C extends Containerable> PrismContainer<C> parseContainer(String dataString,
                                                         Class<C> type,
                                                         String language)
                                                       throws SchemaException

Throws:

SchemaException

parseContainer

public <C extends Containerable> PrismContainer<C> parseContainer(String dataString,
                                                         PrismContainerDefinition<C> containerDef,
                                                         String language)
                                                       throws SchemaException

Throws:

SchemaException

parseContainer

public <C extends Containerable> PrismContainer<C> parseContainer(String dataString,
                                                         String language)
                                                       throws SchemaException

Parses prism container, trying to autodetect the definition from the root node name (if present) or from node type. Both single and multivalued containers are supported.

Parameters:

dataString - String to be parsed.

language - Language to be used.

Returns:

Throws:

SchemaException

parseAtomicValue

public <T> T parseAtomicValue(String dataString,
                     QName typeName,
                     String language)
                   throws SchemaException

Parses an atomic value - i.e. something that could present a property value, if such a property would exist.

Throws:

SchemaException

parseAtomicValue

public <T> T parseAtomicValue(String dataString,
                     QName typeName)
                   throws SchemaException

Throws:

SchemaException

parseAtomicValue

public <T> T parseAtomicValue(File file,
                     QName typeName,
                     String language)
                   throws SchemaException,
                          IOException

Throws:

SchemaException

IOException

parseAtomicValue

public <T> T parseAtomicValue(File file,
                     QName typeName)
                   throws SchemaException,
                          IOException

Throws:

SchemaException

IOException

parseAnyData

public Object parseAnyData(String dataString,
                  String language)
                    throws SchemaException

Parses (almost) anything: either an item with a definition, or an atomic (i.e. property-like) value. Does not care for schemaless items! CAUTION: EXPERIMENTAL - Avoid using this method if at all possible. Its result is not well defined, namely, whether it returns Item or a value.

Returns:

either Item or an unmarshalled bean value

Throws:

SchemaException

parseAnyData

public Object parseAnyData(File file)
                    throws SchemaException,
                           IOException

Throws:

SchemaException

IOException

parseAnyValue

public <T> T parseAnyValue(File file)
                throws SchemaException,
                       IOException

Emulates JAXB unmarshal method. TODO

Returns:

Throws:

SchemaException

IOException

parseAnyValue

public <T> T parseAnyValue(Element element)
                throws SchemaException

Throws:

SchemaException

parseAnyValue

public <T> T parseAnyValue(InputStream inputStream,
                  String language)
                throws SchemaException,
                       IOException

Throws:

SchemaException

IOException

parseAnyValue

public <T> T parseAnyValue(String dataString,
                  String language)
                throws SchemaException

Throws:

SchemaException

parseAnyValueAsJAXBElement

public <T> JAXBElement<T> parseAnyValueAsJAXBElement(String dataString,
                                            String language)
                                          throws SchemaException

Throws:

SchemaException

parseToXNode

public XNode parseToXNode(String dataString,
                 String language)
                   throws SchemaException

Throws:

SchemaException

serializeXNodeToString

public String serializeXNodeToString(RootXNode xroot,
                            String language)
                              throws SchemaException

Throws:

SchemaException

adopt

public <T extends Objectable> void adopt(PrismObject<T> object,
                                Class<T> declaredType)
           throws SchemaException

Set up the specified object with prism context instance and schema definition.

Throws:

SchemaException

adopt

public <T extends Objectable> void adopt(PrismObject<T> object)
           throws SchemaException

Throws:

SchemaException

adopt

public void adopt(Objectable objectable)
           throws SchemaException

Throws:

SchemaException

adopt

public void adopt(Containerable containerable)
           throws SchemaException

Throws:

SchemaException

adopt

public void adopt(PrismContainerValue value)
           throws SchemaException

Throws:

SchemaException

adopt

public <T extends Objectable> void adopt(ObjectDelta<T> delta)
           throws SchemaException

Throws:

SchemaException

adopt

public <C extends Containerable,O extends Objectable> void adopt(C containerable,
                                                        Class<O> type,
                                                        ItemPath path)
           throws SchemaException

Throws:

SchemaException

adopt

public <C extends Containerable,O extends Objectable> void adopt(PrismContainerValue<C> prismContainerValue,
                                                        Class<O> type,
                                                        ItemPath path)
           throws SchemaException

Throws:

SchemaException

adopt

public <C extends Containerable,O extends Objectable> void adopt(PrismContainerValue<C> prismContainerValue,
                                                        QName typeName,
                                                        ItemPath path)
           throws SchemaException

Throws:

SchemaException

serializeObjectToString

public <O extends Objectable> String serializeObjectToString(PrismObject<O> object,
                                                    String language)
                               throws SchemaException

Throws:

SchemaException

serializeContainerValueToString

public <C extends Containerable> String serializeContainerValueToString(PrismContainerValue<C> cval,
                                                               QName elementName,
                                                               String language)
                                       throws SchemaException

Throws:

SchemaException

serializeAtomicValue

public String serializeAtomicValue(Object value,
                          QName elementName,
                          String language)
                            throws SchemaException

Serializes an atomic value - i.e. something that fits into a prism property (if such a property would exist).

Parameters:

value - Value to be serialized.

elementName - Element name to be used.

language -

Returns:

Throws:

SchemaException - BEWARE, currently works only for values that can be processed via PrismBeanConvertor - i.e. not for special cases like PolyStringType, ProtectedStringType, etc.

serializeAtomicValue

public String serializeAtomicValue(Object value,
                          QName elementName,
                          String language,
                          SerializationOptions serializationOptions)
                            throws SchemaException

Throws:

SchemaException

serializeAtomicValue

public String serializeAtomicValue(JAXBElement<?> element,
                          String language)
                            throws SchemaException

Throws:

SchemaException

serializeAnyData

public String serializeAnyData(Object object,
                      String language)
                        throws SchemaException

Serializes any data - i.e. either Item or an atomic value. Does not support PrismValues: TODO: implement that!

Parameters:

object -

language -

Returns:

Throws:

SchemaException

serializeAnyData

public String serializeAnyData(Object object,
                      QName defaultRootElementName,
                      String language)
                        throws SchemaException

Throws:

SchemaException

serializeAnyDataToElement

public Element serializeAnyDataToElement(Object object,
                                QName defaultRootElementName)
                                  throws SchemaException

Throws:

SchemaException

serializeAnyDataToElement

public Element serializeAnyDataToElement(Object object,
                                QName defaultRootElementName,
                                SerializationContext ctx)
                                  throws SchemaException

Throws:

SchemaException

canSerialize

public boolean canSerialize(Object value)

serializeToDom

@Deprecated
public <O extends Objectable> Element serializeToDom(PrismObject<O> object)
                       throws SchemaException

Deprecated.

Throws:

SchemaException

serializeValueToDom

@Deprecated
public Element serializeValueToDom(PrismValue pval,
                                     QName elementName)
                            throws SchemaException

Deprecated.

Throws:

SchemaException

serializeValueToDom

@Deprecated
public Element serializeValueToDom(PrismValue pval,
                                     QName elementName,
                                     Document document)
                            throws SchemaException

Deprecated.

Throws:

SchemaException

toRawType

public RawType toRawType(Item item)
                  throws SchemaException

A bit of hack: serializes any Item into a RawType. Currently used for serializing script output, until a better method is devised.

Returns:

Throws:

SchemaException

createObject

public <T extends Objectable> PrismObject<T> createObject(Class<T> clazz)
                                               throws SchemaException

Throws:

SchemaException

createObjectable

public <T extends Objectable> T createObjectable(Class<T> clazz)
                                      throws SchemaException

Throws:

SchemaException

newParsingContext

protected ParsingContext newParsingContext()