|
Oracle® Mail Java API Reference 10g Release 1 (10.1.1) B14492-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--oracle.mail.sdk.rule.RuleParser
This class provides APIs to store, retrieve and validate rules. Before using this class, you need an OESContext object that has been authenticated, or an OESUser object to supply the directory information.
OESContext
Constructor Summary | |
RuleParser() Default Constructor |
|
RuleParser(OESContext thecontext) Constructs a RuleParser object with a given authentication context |
|
RuleParser(OESUser theUser) Constructs a RuleParser object with a given OESUser object |
Method Summary | |
oracle.mail.sdk.rule.XMLDocument |
fileToDoc(java.lang.String fileName) Parse rule data in XML text from a file and return an XMLDocument object. |
java.lang.String |
getRule() Gets a user level rule as XML text as a regular mail user |
java.lang.String |
getRule(java.lang.String name, java.lang.String ruleType) Retrieves rule as XML text as an administrator |
Account |
getRuleObjects() Retrieves rule data as Java objects as a regular mail user |
Account |
getRuleObjects(java.io.Reader ruleReader) Retreives rule data in Java objects given a Reader |
Account |
getRuleObjects(java.lang.String name, java.lang.String ruleType) Retrieves rule data in Java objects for a user as an administrator |
void |
renameUpdate(java.lang.String oldUsername, java.lang.String newUsername, ESDSContext dctx, java.sql.Connection conn) Perform rule update as a result of a rename. |
java.lang.String |
renameUpdateInMailStore(java.lang.String oldUsername, java.lang.String newUsername, java.lang.String ruleText, java.lang.String userid, java.sql.Connection conn) Perform rule update in mailstore as a result of a rename. |
void |
setAuthContext(OESContext oes) Sets authentication context. |
void |
setDebugMode(boolean mode) Change debug setting (stdout based logging) |
void |
setEncryptionMode(boolean mode) Change password encryption setting |
void |
setRule(oracle.mail.sdk.rule.XMLDocument rule) Validate and save rule data in persistent storage. |
void |
setRuleObjects(Account rules) Saves rule to the directory given an Account object |
void |
setUser(OESUser theUser) Sets OESUser context. |
void |
setValidation(boolean toValidate) Sets rule validation mode. |
oracle.mail.sdk.rule.XMLDocument |
stringToDoc(java.lang.String str) Parses rule data in XML text and return an XMLDocument object. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public RuleParser() throws java.lang.Exception
public RuleParser(OESContext thecontext) throws java.lang.Exception
thecontext
- the authenticated OESContext objectOESContext
public RuleParser(OESUser theUser) throws java.lang.Exception
theUser
- the authenticated OESUser objectOESUser
Method Detail |
public void setDebugMode(boolean mode) throws java.lang.Exception
mode
- the debug mode, true for stdout logging, false otherwisepublic void setEncryptionMode(boolean mode) throws java.lang.Exception
mode
- the encryption mode, true for enable encryption, false otherwisepublic void setValidation(boolean toValidate)
whether
- to validate rules inputpublic void setAuthContext(OESContext oes)
oes
- the OESContext object containing authentication infoOESContext
public void setUser(OESUser theUser)
user
- the OESUser object containing directory infoOESUser
public oracle.mail.sdk.rule.XMLDocument stringToDoc(java.lang.String str) throws java.lang.Exception
str
- rule data in XML textpublic oracle.mail.sdk.rule.XMLDocument fileToDoc(java.lang.String fileName) throws java.lang.Exception
fileName
- file containing XML textpublic java.lang.String getRule(java.lang.String name, java.lang.String ruleType) throws java.lang.Exception
name
- the fully qualified name of the rule owner, can be either a user email address, a domain name or an installation name eg. john.doe@oracle.com, dmv.gov, install1ruleType
- values from ownerType attribute: "user", "domain" or "system"public java.lang.String getRule() throws java.lang.Exception
public Account getRuleObjects(java.io.Reader ruleReader) throws java.io.IOException, oracle.mail.sdk.rule.SAXException, oracle.mail.sdk.rule.XMLParseException
ruleReader
- a Reader object containing rule XML textAccount
public Account getRuleObjects(java.lang.String name, java.lang.String ruleType) throws java.lang.Exception
name
- rule owner name, either a qualified username, domain name or installation nameruleType
- valid values in ownerType attribute: "user", "domain" or "system"Account
public Account getRuleObjects() throws java.lang.Exception
Account
public void setRule(oracle.mail.sdk.rule.XMLDocument rule) throws java.lang.Exception
rule
- an XMLDocument object containing rule dataoracle.xml.parser.v2.XMLDocument
public void setRuleObjects(Account rules) throws java.lang.Exception
rules
- an Account object containing rule dataAccount
public void renameUpdate(java.lang.String oldUsername, java.lang.String newUsername, ESDSContext dctx, java.sql.Connection conn) throws java.lang.Exception
oldUsername
- old mail user ID (qualified)newUsername
- new name (qualified)dctx
- authenticated LDAP contextconn
- JDBC database connectionpublic java.lang.String renameUpdateInMailStore(java.lang.String oldUsername, java.lang.String newUsername, java.lang.String ruleText, java.lang.String userid, java.sql.Connection conn) throws java.lang.Exception
oname
- old user name [Fully qualified]nname
- new name [Fully qualified]ruleText
- existing rule datauserid
- The user ID in mailstoreconn
- JDBC database connection
|
Oracle® Mail Java API Reference 10g Release 1 (10.1.1) B14492-01 |
||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |