All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class lcp.LCP

java.lang.Object
   |
   +----lcp.LCP

public class LCP

extends Object

For information as to the use of the LCP functions, please refer to the documentation located on the Lyris website. The behavior of LCP functions is mostly identical to that of the corresponding LCP functions. The primary differences follow:

• Java booleans are used instead of LCP true/false values.
• Java Strings are used instead of LCP string values.
• Java Vectors (containing Strings) are used instead of LCP arrays.
• Java Hashtables (containing Strings) are used instead of LCP associative arrays.
• Whenever the Lyris Server gives an error in response to an LCP function, an LCPException will be raised. Typically, this signifies bad parameters, although there are other possible causes. The exception will contain a string which is a concatenation of the constant ERROR_serverErr and the error returned by the Lyris Server.
• The Lyris Server can't take any of the following string sequences as input: ~~V, ~~K, or ~~E. If the input to an LCP function contains any of these strings, a LCPException will be raised containing the constant ERROR_invalidInput. When in doubt, confirm a string's validity with the method StringIsValid().

The LCP class can be instanciated either with parameters, or with a configuration file. The configuration file used by the Perl Lyris Toolkit, lyris.plc, will work fine (and is, in fact, the default). Note that the lyris.plc file contains several fields unused by the Java version. Thus, it is recommended that you instead modify the example configuration file, lcp.config, used by "BasicDemo."

See Also:

LCPException

ERROR_badIP

Thrown in a LCPException when the class's IP address was refused connection from host.

ERROR_badPassword

Thrown in a LCPException when the class was refused a connection by the Lyris Server.

ERROR_communicating

Thrown in a LCPException when there was an error communicating with the Lyris Server.

ERROR_invalidInput

Thrown in a LCPException when the String input to functions contains a substring which may cause trouble.

ERROR_noConfigFile

Thrown in a LCPException when the class was unable to load data from a configuration file.

ERROR_noHostIO

Thrown in a LCPException when the class found, but could not connect to, a host.

ERROR_noReconnect

Thrown in a LCPException when the class was disconnected from the Lyris Server, and was unable to reconnect.

ERROR_serverErr

Thrown in a LCPException when the Lyris Server returns an error in response to a function call.

ERROR_unknownHost

Thrown in a LCPException when the class could not find the specified host to connect to.

LCP()

Initializes LCP using the default configuration file lyris.plc.

LCP(String)

Initializes LCP using the parameter configuration file.

LCP(String, int, String, String)

Initializes LCP directly from values: ip address, port number, username, and password (in that order).

ConfigAll()

ConfigAllAttribs()

ConfigAttribs(String)

ConfigCreate(Hashtable)

ConfigDelete(String)

ConfigMultiUpdate(Hashtable)

ConfigReload()

ConfigSerialLimits(String)

ConfigSerialVerify(String)

ConfigUpdate(Hashtable)

CookieClear(String)

CookieGet(String)

CookiePut(String, String)

CountryAll()

CountryAttNetCode(String)

CountryAttribs(String)

CountryCreate(Hashtable)

CountryDelete(String)

CountryEngNat()

CountryLangList()

CountryLangListEngNat()

CountryLanguages(String)

CountryPrimLang(String)

CountryUpdate(Hashtable)

DocAll(String)

DocAllID(String)

DocAttribs(String, String)

DocAttribsID(String)

DocCreate(Hashtable)

DocDelete(String, String)

DocDeleteID(String)

DocIDLangTitle(String)

DocTitleNative(String)

DocTitleType(String, String)

DocTitleTypeText(String, String)

DocTypesAll()

DocTypesAllDesc()

DocUpdate(Hashtable)

DocUpdateID(Hashtable)

FileAll()

FileAttribs(String)

FileCreate(Hashtable)

FileDelete(String)

FileForList(String)

FileUpdate(Hashtable)

FirstTcpip()

IdReset()

InMailAddrTo(String)

InMailAttribs(String)

InMailCreate(Hashtable)

InMailDelete(String)

InMailList(String)

InMailStatus(String)

InMailSummary(String)

InMailSummaryList(String, String)

InMailType(String)

InMailUpdate(Hashtable)

ListAll()

ListAttribs(String)

ListCreate(Hashtable)

ListDelete(String)

ListForSite(String)

ListForTopic(String)

ListForTopicAll(String)

ListForTopicLogo(String)

ListUpdate(Hashtable)

LogAll()

LogAllRange(String, String)

LogAllRangeText(String, String)

LogAttribs(String)

LogCreate(Hashtable)

LogDelete(String)

LogDeleteRange(String, String)

LogFromCreated(String)

LogFromCreatedRange(String, String)

LogFromList(String)

LogFromReferer(String)

LogFromSite(String)

LogFromSource(String)

LogFromUser(String)

LogMinMax()

LogUpdate(Hashtable)

MemberAllEmailID(String)

MemberAllNameEmail(String)

MemberAllNameID(String)

MemberAttEmailList(String, String)

MemberAttNameList(String, String)

MemberAttribs(String)

MemberBatchCreate(String, String)

MemberCount(String)

MemberCountByMemberType(String)

MemberCountBySubdate(String)

MemberCountBySubtype(String)

MemberCreate(Hashtable)

MemberDelAllList(String, String)

MemberDelEmailList(String, String)

MemberDelete(String)

MemberDelNameList(String, String)

MemberEmailMulti(Vector)

MemberFromList(String)

MemberFromListText(String)

MemberGetNumber(String, String)

MemberLogin(String, String, String)

MemberSomeFromListStat(String, String, String, String)

MemberSomeFromListSubtype(String, String, String, String)

MemberSomeFromListText(String, String, String)

MemberUnsub(String)

MemberUpdate(Hashtable)

MemberWhatAdmin(String, String)

MemberWhatLists(String)

MemberWhoAdmin(String)

MemberWhoAdminText(String)

MessageAttribs(String)

MessageCreate(Hashtable)

MessageDates(String)

MessageDelete(String)

MessageDescripts(Vector)

MessageFetchAroundText(String, String, String, String, boolean)

MessageFetchSome(String, String, String, boolean)

MessageFetchSomeText(String, String, String, boolean)

MessageFromDate(String, String)

MessageFromList(String)

MessageFromStatus(String)

MessageNext(String, String)

MessageNextText(String, String)

MessagePrevious(String, String)

MessagePreviousText(String, String)

MessageSearch(String, String, String, boolean, boolean, boolean)

MessageUpdate(Hashtable)

ModerateAll(String)

ModerateAllText(String)

ModerateApprove(String)

ModerateAttribs(String)

ModerateCreate(Hashtable)

ModerateDelete(String)

ModerateReject(String)

ModerateUpdate(Hashtable)

OutMailAll()

OutMailAttribs(String)

OutMailCreate(Hashtable)

OutMailDelete(String)

OutMailList(String)

OutMailStatus(String)

OutMailSummary(String)

OutMailSummaryList(String, String)

OutMailSummaryListType(String, String, String)

OutMailSummaryStatusListType(String, String, String, String)

OutMailSummaryStatusType(String, String, String)

OutMailSummaryType(String, String)

OutMailType(String)

OutMailUpdate(Hashtable)

PeopleAll(String)

PeopleAttribs(String)

PeopleCreate(Hashtable)

PeopleDelete(String)

PeopleNameEmail(String)

PeopleUpdate(Hashtable)

PhraseAll(String)

PhraseAllText(String)

PhraseAttribs(String)

PhraseCreate(Hashtable)

PhraseDelete(String)

PhraseFromAppliesTo(String, String)

PhraseFromContext(String, String)

PhraseIDText(String, String)

PhraseUpdate(Hashtable)

RespondAll()

RespondAttribs(String)

RespondByList(String)

RespondBySite(String)

RespondCreate(Hashtable)

RespondDelete(String)

RespondUpdate(Hashtable)

SetPriority(String)

Shutdown()

SiteAll()

SiteAttribs(String)

SiteCreate(Hashtable)

SiteDelete(String)

SiteForHostname(String)

SiteUpdate(Hashtable)

StatsAll()

StatsMailSend()

StringIsValid(String)

This function determines whether a string is not expected to cause errors, and hence, will be accepted by LCP as input.

TopicAll(String)

TopicAllLogo(String)

TopicAttribs(String)

TopicCreate(Hashtable)

TopicDelete(String)

TopicUpdate(Hashtable)

 public static final String ERROR_noConfigFile

Thrown in a LCPException when the class was unable to load data from a configuration file.

 public static final String ERROR_unknownHost

Thrown in a LCPException when the class could not find the specified host to connect to.

 public static final String ERROR_noHostIO

Thrown in a LCPException when the class found, but could not connect to, a host. One possible culprit is an incorrect port number.

 public static final String ERROR_badPassword

Thrown in a LCPException when the class was refused a connection by the Lyris Server. Username and password should be verified.

 public static final String ERROR_badIP

Thrown in a LCPException when the class's IP address was refused connection from host.

 public static final String ERROR_communicating

Thrown in a LCPException when there was an error communicating with the Lyris Server. This is most likely due to an unexpected network error.

 public static final String ERROR_noReconnect

Thrown in a LCPException when the class was disconnected from the Lyris Server, and was unable to reconnect. Check that the Lyris Server is still up.

 public static final String ERROR_invalidInput

Thrown in a LCPException when the String input to functions contains a substring which may cause trouble. Currently, these substrings are ~~V, ~~K, and ~~E.

 public static final String ERROR_serverErr

Thrown in a LCPException when the Lyris Server returns an error in response to a function call. The actual exception string will be the variable ERROR_serverErr concatenated with the Lyris Server error returned.

 public LCP(String config_filename) throws LCPException

Initializes LCP using the parameter configuration file. If there is an error, it will fall back on the default configuration file lyris.plc. If either works, LCP will then connect to the server with parameters given.

Parameters:

config_filename - The name of the configuration file to use.

Throws: LCPException

if there was an error reading the configuration file, or connecting. Please refer to the public ERROR strings for possible exception strings.

 public LCP() throws LCPException

Initializes LCP using the default configuration file lyris.plc. If successful, LCP will then connect to the server with the loaded parameters.

Throws: LCPException

if there was an error reading the configuration file, or connecting. Please refer to the public ERROR strings for possible exception strings.

 public LCP(String ip_addr,
            int ip_port,
            String usr,
            String pwd) throws LCPException

Initializes LCP directly from values: ip address, port number, username, and password (in that order). Attempts to connect to the LyrisServer using the given values.

Throws: LCPException

if there was an error connecting to the Lyris Server. Please refer to the public ERROR strings for possible exception strings.

 public boolean StringIsValid(String str)

This function determines whether a string is not expected to cause errors, and hence, will be accepted by LCP as input. Currently, strings not containing ~~V, ~~K, or ~~E are ok.

 public Vector ConfigAll() throws LCPException

 public Hashtable ConfigAllAttribs() throws LCPException

 public Hashtable ConfigAttribs(String p) throws LCPException

 public boolean ConfigCreate(Hashtable h) throws LCPException

 public boolean ConfigDelete(String p) throws LCPException

 public Hashtable ConfigMultiUpdate(Hashtable h) throws LCPException

 public void ConfigReload() throws LCPException

 public Hashtable ConfigSerialLimits(String p) throws LCPException

 public boolean ConfigSerialVerify(String p) throws LCPException

 public boolean ConfigUpdate(Hashtable h) throws LCPException

 void CookieClear(String p) throws LCPException

 String CookieGet(String p) throws LCPException

 void CookiePut(String p1, String p2) throws LCPException

 public Vector CountryAll() throws LCPException

 public Hashtable CountryAttNetCode(String p) throws LCPException

 public Hashtable CountryAttribs(String p) throws LCPException

 public boolean CountryCreate(Hashtable h) throws LCPException

 public boolean CountryDelete(String p) throws LCPException

 public Hashtable CountryEngNat() throws LCPException

 public Vector CountryLangList() throws LCPException

 public Hashtable CountryLangListEngNat() throws LCPException

 public Vector CountryLanguages(String p) throws LCPException

 public String CountryPrimLang(String p) throws LCPException

 public boolean CountryUpdate(Hashtable h) throws LCPException

 public Vector DocAll(String p) throws LCPException

 public Vector DocAllID(String p) throws LCPException

 public Hashtable DocAttribs(String p1,
                             String p2) throws LCPException

 public Hashtable DocAttribsID(String p) throws LCPException

 public String DocCreate(Hashtable h) throws LCPException

 public boolean DocDelete(String p1,
                          String p2) throws LCPException

 public boolean DocDeleteID(String p) throws LCPException

 public Hashtable DocIDLangTitle(String p) throws LCPException

 public Hashtable DocTitleNative(String p) throws LCPException

 public Vector DocTitleType(String p1,
                            String p2) throws LCPException

 public Hashtable DocTitleTypeText(String p1,
                                   String p2) throws LCPException

 public Vector DocTypesAll() throws LCPException

 public Hashtable DocTypesAllDesc() throws LCPException

 public boolean DocUpdate(Hashtable h) throws LCPException

 public boolean DocUpdateID(Hashtable h) throws LCPException

 public Vector FileAll() throws LCPException

 public Hashtable FileAttribs(String p) throws LCPException

 public boolean FileCreate(Hashtable h) throws LCPException

 public boolean FileDelete(String p) throws LCPException

 public Vector FileForList(String p) throws LCPException

 public boolean FileUpdate(Hashtable h) throws LCPException

FirstTcpip

 String FirstTcpip() LCPException

IdReset

 String IdReset() LCPException

 public Vector InMailAddrTo(String p) throws LCPException

 public Hashtable InMailAttribs(String p) throws LCPException

 public String InMailCreate(Hashtable h) throws LCPException

 public boolean InMailDelete(String p) throws LCPException

 public Vector InMailList(String p) throws LCPException

 public Vector InMailStatus(String p) throws LCPException

 public Hashtable InMailSummary(String p) throws LCPException

 public Hashtable InMailSummaryList(String p1,
                                    String p2) throws LCPException

 public Vector InMailType(String p) throws LCPException

 public boolean InMailUpdate(Hashtable h) throws LCPException

 public Vector ListAll() throws LCPException

 public Hashtable ListAttribs(String p) throws LCPException

 public boolean ListCreate(Hashtable h) throws LCPException

 public boolean ListDelete(String p) throws LCPException

 public Vector ListForSite(String p) throws LCPException

 public Vector ListForTopic(String p) throws LCPException

 public Vector ListForTopicAll(String p) throws LCPException

 public Hashtable ListForTopicLogo(String p) throws LCPException

 public boolean ListUpdate(Hashtable h) throws LCPException

 public Vector LogAll() throws LCPException

 public Vector LogAllRange(String p1,
                           String p2) throws LCPException

 public Hashtable LogAllRangeText(String p1,
                                  String p2) throws LCPException

 public Hashtable LogAttribs(String p) throws LCPException

 public String LogCreate(Hashtable h) throws LCPException

 public boolean LogDelete(String p) throws LCPException

LogDeleteRange

 String LogDeleteRange(String p1, String p2) LCPException

 public Vector LogFromCreated(String p) throws LCPException

 public Vector LogFromCreatedRange(String p1,
                                   String p2) throws LCPException

LogFromList

 Array LogFromList(String str) throws LCPException

 public Vector LogFromReferer(String p) throws LCPException

LogFromSite

 Array LogFromSite(String str) throws LCPException

LogFromSource

 Array LogFromSource(String str) throws LCPException

 public Vector LogFromUser(String p) throws LCPException

 public Vector LogMinMax() throws LCPException

 public boolean LogUpdate(Hashtable h) throws LCPException

 public Hashtable MemberAllEmailID(String p) throws LCPException

 public Hashtable MemberAllNameEmail(String p) throws LCPException

 public Hashtable MemberCountBySubdate(String p) throws LCPException

 public Hashtable MemberAllNameID(String p) throws LCPException

 public Hashtable MemberAttEmailList(String p1,
                                     String p2) throws LCPException

 public Hashtable MemberAttNameList(String p1,
                                    String p2) throws LCPException

 public Hashtable MemberAttribs(String p) throws LCPException

 public String MemberBatchCreate(String p1,
                                 String p2) throws LCPException

 public String MemberCount(String p) throws LCPException

MemberCountByMemberType

 AssociativeArray MemberCountByMemberType(String str) throws LCPException

MemberCountBySubdate

 AssociativeArray MemberCountBySubdate(String str) throws LCPException

MemberCountBySubtype

 AssociativeArray MemberCountBySubtype(String str) throws LCPException

 public String MemberCreate(Hashtable h) throws LCPException

 String MemberDelAllList(String p1,
                         String p2) throws LCPException

 public boolean MemberDelEmailList(String p1,
                                   String p2) throws LCPException

 public boolean MemberDelNameList(String p1,
                                  String p2) throws LCPException

 public boolean MemberDelete(String p) throws LCPException

 public Vector MemberFromList(String p) throws LCPException

 public Hashtable MemberFromListText(String p) throws LCPException

 public String MemberGetNumber(String p1,
                               String p2) throws LCPException

 public String MemberLogin(String p1,
                           String p2,
                           String p3) throws LCPException

 public Hashtable MemberSomeFromListStat(String p1,
                                         String p2,
                                         String p3,
                                         String p4) throws LCPException

MemberSomeFromListSubtype

 AssociativeArray MemberSomeFromListSubtype(String p1,
                                         String p2,
                                         String p3,
                                         String p4) throws LCPException

 public Hashtable MemberSomeFromListText(String p1,
                                         String p2,
                                         String p3) throws LCPException

MemberUnsub

 boolean MemberUnsub(String str) throws LCPException

 public boolean MemberUpdate(Hashtable h) throws LCPException

 public Vector MemberWhatAdmin(String p1,
                               String p2) throws LCPException

 public Vector MemberWhatLists(String p) throws LCPException

MemberWhoAdmin

 Array MemberWhoAdmin(String str) throws LCPException

MemberWhoAdminText

 AssociativeArray MemberWhoAdminText(String str) throws LCPException

 public Hashtable MessageAttribs(String p) throws LCPException

 public String MessageCreate(Hashtable h) throws LCPException

 public Vector MessageDates(String p) throws LCPException

 public boolean MessageDelete(String p) throws LCPException

 public Hashtable MessageDescripts(Vector v) throws LCPException

 public Hashtable MemberEmailMulti(Vector v) throws LCPException

 public Hashtable MessageFetchAroundText(String p1,
                                         String p2,
                                         String p3,
                                         String p4,
                                         boolean b) throws LCPException

 public Vector MessageFetchSome(String p1,
                                String p2,
                                String p3,
                                boolean b) throws LCPException

 public Hashtable MessageFetchSomeText(String p1,
                                       String p2,
                                       String p3,
                                       boolean b) throws LCPException

 public String MessageFromDate(String p1,
                               String p2) throws LCPException

 public Vector MessageFromList(String p) throws LCPException

 public Vector MessageFromStatus(String p) throws LCPException

 public String MessageNext(String p1,
                           String p2) throws LCPException

 public Hashtable MessageNextText(String p1,
                                  String p2) throws LCPException

 public String MessagePrevious(String p1,
                               String p2) throws LCPException

MessagePreviousText

 AssociativeArray MessagePreviousText(String p1,
                                      String p2) throws LCPException

 public Hashtable MessageSearch(String p1,
                                String p2,
                                String p3,
                                boolean b1,
                                boolean b2,
                                boolean b3) throws LCPException

 public boolean MessageUpdate(Hashtable h) throws LCPException

 public Vector ModerateAll(String p) throws LCPException

 public Hashtable ModerateAllText(String p) throws LCPException

 public boolean ModerateApprove(String p) throws LCPException

 public Hashtable ModerateAttribs(String p) throws LCPException

 public boolean ModerateCreate(Hashtable h) throws LCPException

 public boolean ModerateDelete(String p) throws LCPException

 public boolean ModerateReject(String p) throws LCPException

 public boolean ModerateUpdate(Hashtable h) throws LCPException

 public Vector OutMailAll() throws LCPException

 public Hashtable OutMailAttribs(String p) throws LCPException

 public String OutMailCreate(Hashtable h) throws LCPException

 public boolean OutMailDelete(String p) throws LCPException

 public Vector OutMailList(String p) throws LCPException

 public Vector OutMailStatus(String p) throws LCPException

 public Hashtable OutMailSummary(String p) throws LCPException

 public Hashtable OutMailSummaryList(String p1,
                                     String p2) throws LCPException

 public Hashtable OutMailSummaryListType(String p1,
                                         String p2,
                                         String p3) throws LCPException

 public Hashtable OutMailSummaryStatusListType(String p1,
                                               String p2,
                                               String p3,
                                               String p4) throws LCPException

 public Hashtable OutMailSummaryStatusType(String p1,
                                           String p2,
                                           String p3) throws LCPException

 public Hashtable OutMailSummaryType(String p1,
                                     String p2) throws LCPException

 public Vector OutMailType(String p) throws LCPException

 public boolean OutMailUpdate(Hashtable h) throws LCPException

 public Vector PeopleAll(String p) throws LCPException

 public Hashtable PeopleAttribs(String p) throws LCPException

 public boolean PeopleCreate(Hashtable h) throws LCPException

 public boolean PeopleDelete(String p) throws LCPException

 public Hashtable PeopleNameEmail(String p) throws LCPException

 public boolean PeopleUpdate(Hashtable h) throws LCPException

 public Vector PhraseAll(String p) throws LCPException

 public Hashtable PhraseAllText(String p) throws LCPException

 public Hashtable PhraseAttribs(String p) throws LCPException

 public String PhraseCreate(Hashtable h) throws LCPException

 public boolean PhraseDelete(String p) throws LCPException

 public Vector PhraseFromAppliesTo(String p1, String p2) throws LCPException

 public Vector PhraseFromContext(String p1, String p2) throws LCPException

 public Hashtable PhraseIDText(String p1,
                               String p2) throws LCPException

 public boolean PhraseUpdate(Hashtable h) throws LCPException

 public Vector RespondAll() throws LCPException

 public Hashtable RespondAttribs(String p) throws LCPException

 public Hashtable RespondByList(String p) throws LCPException

 public Hashtable RespondBySite(String p) throws LCPException

 public boolean RespondCreate(Hashtable h) throws LCPException

 public boolean RespondDelete(String p) throws LCPException

 public boolean RespondUpdate(Hashtable h) throws LCPException

SetPriority

 void  SetPriority(String str) throws LCPException

 public Vector SiteAll() throws LCPException

 public Hashtable SiteAttribs(String p) throws LCPException

 public boolean SiteCreate(Hashtable h) throws LCPException

 public boolean SiteDelete(String p) throws LCPException

SiteForHostname

 AssociativeArray SiteForHostname(String str) throws LCPException

 public boolean SiteUpdate(Hashtable h) throws LCPException

 public String StatsAll() throws LCPException

 public String StatsMailSend() throws LCPException

 public Vector TopicAll(String p) throws LCPException

 public Hashtable TopicAllLogo(String p) throws LCPException

 public Hashtable TopicAttribs(String p) throws LCPException

 public boolean TopicCreate(Hashtable h) throws LCPException

 public boolean TopicDelete(String p) throws LCPException

 public boolean TopicUpdate(Hashtable h) throws LCPException

 public void Shutdown() throws LCPException

All Packages  Class Hierarchy  This Package  Previous  Next  Index