Quercus:Resin module

Revision as of 17:52, 21 April 2006

jndi_lookup

Returns an object located using a jndi name, or null if no object matches the name.

 $hogwarts = jndi_lookup("java:comp/env/persistence/PersistenceContext/hogwarts");

If the name begins with "java:comp/env/", then the "java:comp/env/" does not need to be included in the name.

 $hogwarts = jndi_lookup("persistence/PersistenceContext/hogwarts")

mbean_explode

Explode an object name into an array. The domain is stored under the key named ":".

<?php
 
  $webappName = "resin:type=WebApp,Server=default,Host=default,name=/foo"
 
  $exploded = mbean_explode($name);
 
  var_dump($exploded);

?>

array(5) {
  [":"]=>      string(5) "resin"
  ["Host"]=>   string(7) "default"
  ["name"]=>   string(4) "/foo"
  ["type"]=>   string(6) "WebApp"
  ["Server"]=> string(7) "default"
}

mbean_implode

Implode an array into an object name. The domain is stored under the key named ":".

<?php
   
  $array = array(":" => "resin", "Host" => "default", "name" => "/foo", "type" => "WebApp", "Server" => "default") ;
   
  $webappName = mbean_implode($array);
     
  var_dump($webappName);
 
?>

string(55) "resin:Host=default,Server=default,name=/foo,type=WebApp"

mbean_lookup

Returns an mbean object located using a jmx name, or null if no object matches the name.

 $hogwartsApp = mbean_lookup("resin:type=WebApp,Server=default,Host=default,name=/hogwarts");

If the name does not contain a `:', then it is a partial name and the lookup is done as if the name contained the fully qualified name of the current web application. For example, the following are equivalent if performed from the web-app /hogwarts:

 $foo = mbean_lookup("resin:Server=default,Host=default,WebApp=/hogwarts,type=MyMBean,name=foo");
 $foo = mbean_lookup("type=MyMBean,name=foo");

If the name is not provided, then the object that is returned is the mbean for the web application.

 $app = mbean_lookup();

mbean_query

Returns an array of object names that match a JMX query.

<?php
   $webappNames = mbean_query("resin:type=WebApp,*"); 

   foreach ($webappNames as $webappName) {
     echo $webappName . "\n";

     $webapp = mbean_lookup($webappName);

     ...
  }
?>

 resin:type=WebApp,Server=default,Host=default,name=/
 resin:type=WebApp,Server=default,Host=default,name=/gryffindor

xa_begin()

 xa_begin()
   throws Exception

Begin distributed transaction.

xa_commit()

 xa_commit()
   throws Exception

Commit distributed transaction.

xa_rollback

 xa_rollback()
   throws Exception

Rollback distributed transaction.

xa_rollback_only

 xa_rollback_only()
   throws Exception

Marks transactions as rollback only, commit is no longer possible.

xa_set_timeout(int timeoutSeconds)

 xa_set_timeout(int timeoutSeconds)
   throws Exception

xa_status

int xa_status()
   throws Exception

Returns one of XA_STATUS_NO_TRANSACTION, XA_STATUS_ACTIVE, XA_STATUS_MARKED_ROLLBACK, XA_STATUS_PREPARING, XA_STATUS_PREPARED, XA_STATUS_COMMITTING, XA_STATUS_COMMITTED, XA_STATUS_ROLLING_BACK, XA_STATUS_ROLLEDBACK, XA_STATUS_UNKNOWN.