Jump to

• Request
• Response

View This Startup Class Collection

get

/management/weblogic/{version}/edit/startupClasses

View this startup class collection.

Request

Path Parameters

• 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 a list of startup class entities.

This method can return the following links:

• rel=create-form uri=/management/weblogic/{version}/edit/startupClassCreateForm

  The create form resource for this collection resource.

Body ()

Root Schema : Items

Type: array

Title: Items

Show Source

• Array of: object Startup Class

{
    "title":"Items",
    "type":"array",
    "items":{
        "$ref":"#/definitions/Startup Class"
    },
    "description":""
}

Nested Schema : Startup Class

Type: object

Show Source

• arguments(optional): string

  Arguments that a server uses to initialize a class.

  Separate multiple arguments with a comma. For example:

  first=MyFirstName,last=MyLastName

• className(optional): string

  The fully qualified name of a class to load and run. The class must be on the server's classpath.

  For example, mycompany.mypackage.myclass

  Constraints

  • legal null
• deploymentOrder(optional): integer(int32)
  Minimum Value: 0

  Maximum Value: 2147483647

  Default Value: 1000

  A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.

  For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.

  Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.

• dynamicallyCreated(optional): boolean
  Read Only: true

  Default Value: false

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

• failureIsFatal(optional): boolean
  Default Value: false

  Specifies whether a failure in this startup class prevents the targeted server(s) from starting.

  If you specify that failure is not fatal, if the startup class fails, the server continues its startup process.

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

  Return the unique id of this MBean instance

• loadAfterAppsRunning(optional): boolean
  Default Value: false

  Specifies whether the targeted servers load and run this startup class after applications and EJBs are running.

  If you enable this feature for a startup class, a server loads and runs the startup class after the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)

  Enable this feature if the startup class needs to be invoked after applications are running and ready to service client requests.

  If you do not enable this feature, LoadBeforeAppDeployments or LoadBeforeAppActivation, a server instance loads startup classes when applications go to the admin state.

• loadBeforeAppActivation(optional): boolean
  Default Value: false

  Specifies whether the targeted servers load and run this startup class after activating JMS and JDBC services and before activating applications and EJBs.

  If you enable this feature for a startup class, a server loads and runs the startup class before the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)

  Enable this feature if the startup class needs to be invoked after JDBC connection pools are available but before the applications are activated and ready to service client requests.

  If you do not enable this feature, LoadBeforeAppDeployments or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.

• loadBeforeAppDeployments(optional): boolean
  Default Value: false

  Specifies whether the targeted servers load and run this startup class before activating JMS and JDBC services and before starting deployment for applications and EJBs.

  If you enable this feature for a startup class, a server loads and runs the startup class before the deployment prepare phase. At this point, JMS and JDBC services are not yet available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)

  If you do not enable this feature, LoadBeforeAppActivation or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.

• 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.

• tags(optional): array Items
  Title: Items

  Return all tags on this Configuration MBean

• targets(optional): array Target References
  Title: Target References

  Contains the array of target references.

  You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

• type(optional): string
  Read Only: true

  Returns the type of the MBean.

  Constraints

  • unharvestable

{
    "type":"object",
    "properties":{
        "arguments":{
            "type":"string",
            "description":"<p>Arguments that a server uses to initialize a class.</p><p>Separate multiple arguments with a comma. For example:</p><p><code>first=MyFirstName,last=MyLastName</code></p>"
        },
        "className":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>The fully qualified name of a class to load and run. The class must be on the server's classpath.</p><p>For example, <code>mycompany.mypackage.myclass</code></p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "deploymentOrder":{
            "default":1000,
            "minimum":0,
            "maximum":2147483647,
            "type":"integer",
            "format":"int32",
            "description":"<p>A priority that the server uses to determine when it deploys an item. The priority is relative to other deployable items of the same type.</p><p>For example, the server prioritizes and deploys all EJBs before it prioritizes and deploys startup classes.</p><p>Items with the lowest Deployment Order value are deployed first. There is no guarantee on the order of deployments with equal Deployment Order values. There is no guarantee of ordering across clusters.</p>"
        },
        "dynamicallyCreated":{
            "readOnly":true,
            "default":false,
            "type":"boolean",
            "description":"<p>Return whether the MBean was created dynamically or is persisted to config.xml</p>"
        },
        "failureIsFatal":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether a failure in this startup class prevents the targeted server(s) from starting.</p><p>If you specify that failure is <b>not</b> fatal, if the startup class fails, the server continues its startup process.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p>Return the unique id of this MBean instance</p>"
        },
        "loadAfterAppsRunning":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the targeted servers load and run this startup class after applications and EJBs are running.</p><p>If you enable this feature for a startup class, a server loads and runs the startup class after the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)</p><p>Enable this feature if the startup class needs to be invoked after applications are running and ready to service client requests.</p><p>If you do not enable this feature, LoadBeforeAppDeployments or LoadBeforeAppActivation, a server instance loads startup classes when applications go to the admin state.</p>"
        },
        "loadBeforeAppActivation":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the targeted servers load and run this startup class after activating JMS and JDBC services and before activating applications and EJBs.</p><p>If you enable this feature for a startup class, a server loads and runs the startup class before the activate phase. At this point, JMS and JDBC services are available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)</p><p>Enable this feature if the startup class needs to be invoked after JDBC connection pools are available but before the applications are activated and ready to service client requests.</p><p>If you do not enable this feature, LoadBeforeAppDeployments or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.</p>"
        },
        "loadBeforeAppDeployments":{
            "default":false,
            "type":"boolean",
            "description":"<p>Specifies whether the targeted servers load and run this startup class before activating JMS and JDBC services and before starting deployment for applications and EJBs.</p><p>If you enable this feature for a startup class, a server loads and runs the startup class before the deployment prepare phase. At this point, JMS and JDBC services are not yet available. (Deployment for applications and EJBs consists of three phases: prepare, admin and activate.)</p><p>If you do not enable this feature, LoadBeforeAppActivation or LoadAfterAppsRunning, a server instance loads startup classes when applications go to the admin state.</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>"
        },
        "tags":{
            "title":"Items",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"<p>Return all tags on this Configuration MBean</p>"
        },
        "targets":{
            "title":"Target References",
            "type":"array",
            "items":{
                "title":"Target Reference",
                "type":"object",
                "properties":{
                    "identity":{
                        "title":"Identity",
                        "type":"array",
                        "items":{
                            "type":"string",
                            "description":""
                        },
                        "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
                    }
                },
                "description":"Contains the target reference."
            },
            "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</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>"
        }
    },
    "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>"
}

Nested Schema : Target References

Type: array

Title: Target References

Contains the array of target references.

You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.

Show Source

• Array of: object Target Reference
  Title: Target Reference

  Contains the target reference.

{
    "title":"Target References",
    "type":"array",
    "items":{
        "title":"Target Reference",
        "type":"object",
        "properties":{
            "identity":{
                "title":"Identity",
                "type":"array",
                "items":{
                    "type":"string",
                    "description":""
                },
                "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
            }
        },
        "description":"Contains the target reference."
    },
    "description":"Contains the array of target references. <p>You must select a target on which an MBean will be deployed from this list of the targets in the current domain on which this item can be deployed. Targets must be either servers or clusters. The deployment will only occur once if deployments overlap.</p>"
}

Nested Schema : Target Reference

Type: object

Title: Target Reference

Contains the target reference.

Show Source

• identity(optional): array Identity
  Title: Identity

  DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

{
    "title":"Target Reference",
    "type":"object",
    "properties":{
        "identity":{
            "title":"Identity",
            "type":"array",
            "items":{
                "type":"string",
                "description":""
            },
            "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
        }
    },
    "description":"Contains the target reference."
}

Nested Schema : Identity

Type: array

Title: Identity

DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource.

Show Source

• Array of: string

{
    "title":"Identity",
    "type":"array",
    "items":{
        "type":"string",
        "description":""
    },
    "description":"DOC TEAM TBD - describe an identity - it's a reference to another WLS REST resource."
}

Back to Top