|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.liferay.portal.service.http.CompanyServiceSoap
public class CompanyServiceSoap
This class provides a SOAP utility for the
CompanyServiceUtil
service utility. The
static methods of this class calls the same methods of the service utility.
However, the signatures are different because it is difficult for SOAP to
support certain types.
ServiceBuilder follows certain rules in translating the methods. For example,
if the method in the service utility returns a List
, that
is translated to an array of CompanySoap
.
If the method in the service utility returns a
Company
, that is translated to a
CompanySoap
. Methods that SOAP cannot
safely wire are skipped.
The benefits of using the SOAP utility is that it is cross platform compatible. SOAP allows different languages like Java, .NET, C++, PHP, and even Perl, to call the generated services. One drawback of SOAP is that it is slow because it needs to serialize all calls into a text format (XML).
You can see a list of services at http://localhost:8080/api/secure/axis. Set the property axis.servlet.hosts.allowed in portal.properties to configure security.
The SOAP utility is only generated for remote services.
CompanyServiceHttp
,
CompanySoap
,
CompanyServiceUtil
Constructor Summary | |
---|---|
CompanyServiceSoap()
|
Method Summary | |
---|---|
static CompanySoap |
addCompany(String webId,
String virtualHost,
String mx,
String shardName,
boolean system,
int maxUsers,
boolean active)
Adds a company. |
static void |
deleteLogo(long companyId)
Deletes the company's logo. |
static CompanySoap |
getCompanyById(long companyId)
Returns the company with the primary key. |
static CompanySoap |
getCompanyByLogoId(long logoId)
Returns the company with the logo. |
static CompanySoap |
getCompanyByMx(String mx)
Returns the company with the mail domian. |
static CompanySoap |
getCompanyByVirtualHost(String virtualHost)
Returns the company with the virtual host name. |
static CompanySoap |
getCompanyByWebId(String webId)
Returns the company with the web domain. |
static void |
removePreferences(long companyId,
String[] keys)
Removes the values that match the keys of the company's preferences. |
static CompanySoap |
updateCompany(long companyId,
String virtualHost,
String mx,
int maxUsers,
boolean active)
Updates the company |
static CompanySoap |
updateCompany(long companyId,
String virtualHost,
String mx,
String homeURL,
String name,
String legalName,
String legalId,
String legalType,
String sicCode,
String tickerSymbol,
String industry,
String type,
String size)
Updates the company with additional account information. |
static void |
updateDisplay(long companyId,
String languageId,
String timeZoneId)
Update the company's display. |
static void |
updateSecurity(long companyId,
String authType,
boolean autoLogin,
boolean sendPassword,
boolean strangers,
boolean strangersWithMx,
boolean strangersVerify,
boolean siteLogo)
Updates the company's security properties. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CompanyServiceSoap()
Method Detail |
---|
public static CompanySoap addCompany(String webId, String virtualHost, String mx, String shardName, boolean system, int maxUsers, boolean active) throws RemoteException
webId
- the company's web domainvirtualHost
- the company's virtual host namemx
- the company's mail domainshardName
- the company's shardsystem
- whether the company is the very first company (i.e., themaxUsers
- the max number of company users (optionally
0
)active
- whether the company is active
PortalException
- if the web domain, virtual host name, or mail
domain was invalid or if the user was not a universal
administrator
SystemException
- if a system exception occurred
RemoteException
public static void deleteLogo(long companyId) throws RemoteException
companyId
- the primary key of the company
PortalException
- if the company with the primary key could not be
found or if the company's logo could not be found or if the user
was not an administrator
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap getCompanyById(long companyId) throws RemoteException
companyId
- the primary key of the company
PortalException
- if a company with the primary key could not be
found
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap getCompanyByLogoId(long logoId) throws RemoteException
logoId
- the ID of the company's logo
PortalException
- if the company with the logo could not be found
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap getCompanyByMx(String mx) throws RemoteException
mx
- the company's mail domain
PortalException
- if the company with the mail domain could not be
found
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap getCompanyByVirtualHost(String virtualHost) throws RemoteException
virtualHost
- the company's virtual host name
PortalException
- if the company with the virtual host name could
not be found or if the virtual host was not associated with a
company
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap getCompanyByWebId(String webId) throws RemoteException
webId
- the company's web domain
PortalException
- if the company with the web domain could not be
found
SystemException
- if a system exception occurred
RemoteException
public static void removePreferences(long companyId, String[] keys) throws RemoteException
EditLDAPServerAction
remotely
through CompanyService
.
companyId
- the primary key of the companykeys
- the company's preferences keys to be remove
PortalException
- if the user was not an administrator
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap updateCompany(long companyId, String virtualHost, String mx, int maxUsers, boolean active) throws RemoteException
companyId
- the primary key of the companyvirtualHost
- the company's virtual host namemx
- the company's mail domainmaxUsers
- the max number of company users (optionally
0
)active
- whether the company is active
PortalException
- if a company with the primary key could not be
found or if the new information was invalid or if the user was
not a universal administrator
SystemException
- if a system exception occurred
RemoteException
public static CompanySoap updateCompany(long companyId, String virtualHost, String mx, String homeURL, String name, String legalName, String legalId, String legalType, String sicCode, String tickerSymbol, String industry, String type, String size) throws RemoteException
companyId
- the primary key of the companyvirtualHost
- the company's virtual host namemx
- the company's mail domainhomeURL
- the company's home URL (optionally null
)name
- the company's account name (optionally null
)legalName
- the company's account legal name (optionally
null
)legalId
- the company's account legal ID (optionally
null
)legalType
- the company's account legal type (optionally
null
)sicCode
- the company's account SIC code (optionally
null
)tickerSymbol
- the company's account ticker symbol (optionally
null
)industry
- the the company's account industry (optionally
null
)type
- the company's account type (optionally null
)size
- the company's account size (optionally null
)
PortalException
- if a company with the primary key could not be
found or if the new information was invalid or if the user was
not an administrator
SystemException
- if a system exception occurred
RemoteException
public static void updateDisplay(long companyId, String languageId, String timeZoneId) throws RemoteException
companyId
- the primary key of the companylanguageId
- the ID of the company's default user's languagetimeZoneId
- the ID of the company's default user's time zone
PortalException
- if the company's default user could not be found
or if the user was not an administrator
SystemException
- if a system exception occurred
RemoteException
public static void updateSecurity(long companyId, String authType, boolean autoLogin, boolean sendPassword, boolean strangers, boolean strangersWithMx, boolean strangersVerify, boolean siteLogo) throws RemoteException
companyId
- the primary key of the companyauthType
- the company's method of authenticating usersautoLogin
- whether to allow users to select the "remember me"
featuresendPassword
- whether to allow users to ask the company to send
their passwordsstrangers
- whether to allow strangers to create accounts to
register themselves in the companystrangersWithMx
- whether to allow strangers to create accounts
with email addresses that match the company mail suffixstrangersVerify
- whether to require strangers who create accounts
to be verified via emailsiteLogo
- whether to to allow site administrators to use their own
logo instead of the enterprise logo
PortalException
- if the user was not an administrator
SystemException
- if a system exception occurred
RemoteException
|
Liferay 6.1.2-ce-ga3 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |