Jump to

• Request
• Response

View This XML Registry

get

/management/weblogic/{version}/serverConfig/XMLRegistries/{name}

View this XML registry.

Request

Path Parameters

• name: string
  The name property of the instance in the collection.
• version: string
  The version of the WebLogic REST interface.

Query Parameters

• excludeFields(optional): string
  The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
• excludeLinks(optional): string
  The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
• fields(optional): string
  The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
• links(optional): string
  The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

• Admin: basic
  Type: basic

  Description: A user in the Admin security role.
• Deployer: basic
  Type: basic

  Description: A user in the Deployer security role.
• Monitor: basic
  Type: basic

  Description: A user in the Monitor security role.
• Operator: basic
  Type: basic

  Description: A user in the Operator security role.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns this XML registry.

This method can return the following links:

• rel=XMLEntitySpecRegistryEntries uri=/management/weblogic/{version}/serverConfig/XMLRegistries/{name}/XMLEntitySpecRegistryEntries

  This resource's XMLEntitySpecRegistryEntries collection resource.

• rel=XMLParserSelectRegistryEntries uri=/management/weblogic/{version}/serverConfig/XMLRegistries/{name}/XMLParserSelectRegistryEntries

  This resource's XMLParserSelectRegistryEntries collection resource.

Body ()

Root Schema : XML Registry

Type: object

Show Source

• documentBuilderFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicDocumentBuilderFactory

  The fully qualified name of the class that implements the DocumentBuilderFactory interface.

  The javax.xml.parsers.DocumentBuilderFactory factory API enables applications deployed to WebLogic Server to obtain an XML parser that produces DOM object trees from XML documents.

  The built-in WebLogic Server DOM factory implementation class is com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a DOM parser. You can change this default by updating this value.

  Return the class name of the default DocumentBuilderFactory

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

  Return whether the MBean was created dynamically or is persisted to config.xml

• handleEntityInvalidation(optional): boolean
  Default Value: false

  Whether cached DTD/schema is invalidated when parsing error is encountered.

• id(optional): integer(int64)
  Read Only: true

  Return the unique id of this MBean instance

• name(optional): string
  Read Only: true

  The user-specified name of this MBean instance.

  This name is included as one of the key properties in the MBean's javax.management.ObjectName

  Name=user-specified-name

  Constraints

  • legal null
• notes(optional): string

  Optional information that you can include to describe this configuration.

  WebLogic Server saves this note in the domain's configuration file (config.xml) as XML PCDATA. All left angle brackets (<) are converted to the xml entity <. Carriage returns/line feeds are preserved.

  Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.

• SAXParserFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicSAXParserFactory

  The fully qualified name of the class that implements the SAXParserFactory interface.

  The javax.xml.parsers.SAXParserFactory factory API enables applications deployed to WebLogic Server to configure and obtain a SAX-based XML parser to parse XML documents.

  The built-in WebLogic Server SAX factory implementation class is com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a SAX parser. You can change this default by updating this value.

  Return the class name of the default SAXParserFactory

• schemaFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicSchemaFactory

  The fully qualified name of the class that implements the SchemaFactory interface.

  The javax.xml.validation.SchemaFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Schema object used to validate XML document using schema.

  The built-in WebLogic Server Schema factory implementation class is com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchemaFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a Schema object. You can change this default by updating this value.

  Return the class name of the default SchemaFactory

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• transformerFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicTransformerFactory

  The fully qualified name of the class that implements the TransformerFactory interface.

  The javax.xml.transform.TransformerFactory factory API enables applications deployed to WebLogic Server to configure and obtain a Transformer object used to transform XML data into another format.

  The built-in WebLogic Server Transformer factory implementation class is com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryIml. This is the factory class applications deployed to WebLogic Server get by default when they request a Transformer object. You can change this default by updating this value.

  Return the class name of the default TransformerFactory

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable
• whenToCache(optional): string
  Default Value: cache-on-reference

  Allowed Values: [ "cache-on-reference", "cache-at-initialization", "cache-never" ]

  Specifies when WebLogic Server should cache external entities that it retrieves from the Web.

  When WebLogic Server resolves an external entity within an XML file and retrieves the entity from the Web, you can specify that WebLogic Server cache this entity only when the entity is first referenced, when WebLogic Server first starts up, or not at all.

• XMLEventFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicXMLEventFactory

  The fully qualified name of the class that implements the XMLEventFactory interface.

  The javax.xml.stream.XMLEventFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEvent object used to parse or build XML streams.

  The built-in WebLogic Server XMLEvent factory implementation class is com.ctc.wstx.stax.WstxEventFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEvent object. You can change this default by updating this value.

  Return the class name of the default XMLEventFactory

• XMLInputFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicXMLInputFactory

  The fully qualified name of the class that implements the XMLInputFactory interface.

  The javax.xml.stream.XMLInputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventReader/XMLStreamReader object used to read XML streams.

  The built-in WebLogic Server XML Input factory implementation class is com.ctc.wstx.stax.WstxInputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventReader/XMLStreamReader object. You can change this default by updating this value.

  Return the class name of the default XMLInputFactory

• XMLOutputFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicXMLOutputFactory

  The fully qualified name of the class that implements the XMLOutputFactory interface.

  The javax.xml.stream.XMLOutputFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XMLEventWriter/XMLStreamWriter object used to write XML streams.

  The built-in WebLogic Server XML Output factory implementation class is com.ctc.wstx.stax.WstxOutputFactory. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventWriter/XMLStreamWriter object. You can change this default by updating this value.

  Return the class name of the default XMLOutputFactory

• xpathFactory(optional): string
  Default Value: weblogic.xml.jaxp.WebLogicXPathFactory

  The fully qualified name of the class that implements the XPathFactory interface.

  The javax.xml.xpath.XPathFactory factory API enables applications deployed to WebLogic Server to configure and obtain a XPath object used to search XML elements.

  The built-in WebLogic Server XPath factory implementation class is com.sun.org.apache.xpath.internal.jaxp.XPathFactoryImpl. This is the factory class applications deployed to WebLogic Server get by default when they request a XPath object. You can change this default by updating this value.

  Return the class name of the default XPathFactory

{
    "type":"object",
    "properties":{
        "SAXParserFactory":{
            "default":"weblogic.xml.jaxp.WebLogicSAXParserFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>SAXParserFactory</code> interface.</p><p>The <code>javax.xml.parsers.SAXParserFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a SAX-based XML parser to parse XML documents.</p><p>The built-in WebLogic Server SAX factory implementation class is <code>com.sun.org.apache.xerces.internal.jaxp.SAXParserFactoryImpl</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a SAX parser.  You can change this default by updating this value.</p><p>Return the class name of the default SAXParserFactory</p>"
        },
        "XMLEventFactory":{
            "default":"weblogic.xml.jaxp.WebLogicXMLEventFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>XMLEventFactory</code> interface.</p><p>The <code>javax.xml.stream.XMLEventFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>XMLEvent</code> object used to parse or build XML streams.</p><p>The built-in WebLogic Server XMLEvent factory implementation class is <code>com.ctc.wstx.stax.WstxEventFactory</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEvent object.  You can change this default by updating this value.</p><p>Return the class name of the default XMLEventFactory</p>"
        },
        "XMLInputFactory":{
            "default":"weblogic.xml.jaxp.WebLogicXMLInputFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>XMLInputFactory</code> interface.</p><p>The <code>javax.xml.stream.XMLInputFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>XMLEventReader/XMLStreamReader</code> object used to read XML streams.</p><p>The built-in WebLogic Server XML Input factory implementation class is <code>com.ctc.wstx.stax.WstxInputFactory</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventReader/XMLStreamReader object. You can change this default by updating this value.</p><p>Return the class name of the default XMLInputFactory</p>"
        },
        "XMLOutputFactory":{
            "default":"weblogic.xml.jaxp.WebLogicXMLOutputFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>XMLOutputFactory</code> interface.</p><p>The <code>javax.xml.stream.XMLOutputFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>XMLEventWriter/XMLStreamWriter</code> object used to write XML streams.</p><p>The built-in WebLogic Server XML Output factory implementation class is <code>com.ctc.wstx.stax.WstxOutputFactory</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a XMLEventWriter/XMLStreamWriter object. You can change this default by updating this value.</p><p>Return the class name of the default XMLOutputFactory</p>"
        },
        "documentBuilderFactory":{
            "default":"weblogic.xml.jaxp.WebLogicDocumentBuilderFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>DocumentBuilderFactory</code> interface.</p><p>The <code>javax.xml.parsers.DocumentBuilderFactory</code> factory API enables applications deployed to WebLogic Server to obtain an XML parser that produces DOM object trees from XML documents.</p><p>The built-in WebLogic Server DOM factory implementation class is <code>com.sun.org.apache.xerces.internal.jaxp.DocumentBuilderFactoryImpl</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a DOM parser.  You can change this default by updating this value.</p><p>Return the class name of the default DocumentBuilderFactory</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "handleEntityInvalidation":{
            "default":false,
            "type":"boolean",
            "description":"<p>Whether cached DTD/schema is invalidated when parsing error is encountered.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "name":{
            "readOnly":true,
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The user-specified name of this MBean instance.</p><p>This name is included as one of the key properties in the MBean's <code>javax.management.ObjectName</code></p><p><code>Name=<i>user-specified-name</i></code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "notes":{
            "type":"string",
            "description":"<p>Optional information that you can include to describe this configuration.</p><p>WebLogic Server saves this note in the domain's configuration file (<code>config.xml</code>) as XML PCDATA. All left angle brackets (<) are converted to the XML entity <code>&lt;</code>. Carriage returns/line feeds are preserved.</p><p>Note: If you create or edit a note from the Administration Console, the Administration Console does not preserve carriage returns/line feeds.</p>"
        },
        "schemaFactory":{
            "default":"weblogic.xml.jaxp.WebLogicSchemaFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>SchemaFactory</code> interface.</p><p>The <code>javax.xml.validation.SchemaFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>Schema</code> object used to validate XML document using schema.</p><p>The built-in WebLogic Server Schema factory implementation class is <code>com.sun.org.apache.xerces.internal.jaxp.validation.XMLSchemaFactory</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a Schema object.  You can change this default by updating this value.</p><p>Return the class name of the default SchemaFactory</p>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "transformerFactory":{
            "default":"weblogic.xml.jaxp.WebLogicTransformerFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>TransformerFactory</code> interface.</p><p>The <code>javax.xml.transform.TransformerFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>Transformer</code> object used to transform XML data into another format.</p><p>The built-in WebLogic Server Transformer factory implementation class is <code>com.sun.org.apache.xalan.internal.xsltc.trax.TransformerFactoryIml</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a Transformer object.  You can change this default by updating this value.</p><p>Return the class name of the default TransformerFactory</p>"
        },
        "type":{
            "readOnly":true,
            "x-weblogic-unharvestable":true,
            "type":"string",
            "description":"<p>Returns the type of the MBean.</p><p><h5>Constraints</h5></p><ul><li>unharvestable</li></ul>"
        },
        "whenToCache":{
            "default":"cache-on-reference",
            "enum":[
                "cache-on-reference",
                "cache-at-initialization",
                "cache-never"
            ],
            "type":"string",
            "description":"<p>Specifies when WebLogic Server should cache external entities that it retrieves from the Web.</p><p>When WebLogic Server resolves an external entity within an XML file and retrieves the entity from the Web, you can specify that WebLogic Server cache this entity only when the entity is first referenced, when WebLogic Server first starts up, or not at all.</p>"
        },
        "xpathFactory":{
            "default":"weblogic.xml.jaxp.WebLogicXPathFactory",
            "type":"string",
            "description":"<p>The fully qualified name of the class that implements the <code>XPathFactory</code> interface.</p><p>The <code>javax.xml.xpath.XPathFactory</code> factory API enables applications deployed to WebLogic Server to configure and obtain a <code>XPath</code> object used to search XML elements.</p><p>The built-in WebLogic Server XPath factory implementation class is <code>com.sun.org.apache.xpath.internal.jaxp.XPathFactoryImpl</code>. This is the factory class applications deployed to WebLogic Server get by default when they request a XPath object.  You can change this default by updating this value.</p><p>Return the class name of the default XPathFactory</p>"
        }
    },
    "description":""
}

Nested Schema : Items

Type: array

Title: Items

Return all tags on this Configuration MBean

Show Source

• Array of: string

{
    "title":"Items",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"<p>Return all tags on this Configuration MBean</p>"
}

Back to Top