API Reference V1 CoreClientServices

Micro Focus Security
ArcSight ESM Service Layer

Software Version: 7.6
API Reference Vol. 1: Core-Client Services
Document Release Date: December 2021

Software Release Date: December 2021
API Reference Vol. 1: Core-Client Services
Legal Notices
Copyright Notice
© Copyright 2001-2021 Micro Focus or one of its affiliates
Confidential computer software. Valid license from Micro Focus required for possession, use or copying. The
information contained herein is subject to change without notice.
The only warranties for Micro Focus products and services are set forth in the express warranty statements
accompanying such products and services. Nothing herein should be construed as constituting an additional warranty.
Micro Focus shall not be liable for technical or editorial errors or omissions contained herein.
No portion of this product's documentation may be reproduced or transmitted in any form or by any means, electronic
or mechanical, including photocopying, recording, or information storage and retrieval systems, for any purpose other
than the purchaser's internal use, without the express written permission of Micro Focus.
Notwithstanding anything to the contrary in your license agreement for Micro Focus ArcSight software, you may
reverse engineer and modify certain open source components of the software in accordance with the license terms for
those particular components. See below for the applicable terms.
U.S. Governmental Rights. For purposes of your license to Micro Focus ArcSight software, “commercial computer
software” is defined at FAR 2.101. If acquired by or on behalf of a civilian agency, the U.S. Government acquires this
commercial computer software and/or commercial computer software documentation and other technical data subject
to the terms of the Agreement as specified in 48 C.F.R. 12.212 (Computer Software) and 12.211 (Technical Data) of the
Federal Acquisition Regulation (“FAR”) and its successors. If acquired by or on behalf of any agency within the
Department of Defense (“DOD”), the U.S. Government acquires this commercial computer software and/or commercial
computer software documentation subject to the terms of the Agreement as specified in 48 C.F.R. 227.7202-3 of the
DOD FAR Supplement (“DFARS”) and its successors. This U.S. Government Rights Section 18.11 is in lieu of, and
supersedes, any other FAR, DFARS, or other clause or provision that addresses government rights in computer software
or technical data.
Trademark Notices
Adobe™ is a trademark of Adobe Systems Incorporated.
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
Support
Contact Information
Phone A list of phone numbers is available on the Technical Support
Page: https://softwaresupport.softwaregrp.com/support-contact-information
Support Web Site https://softwaresupport.softwaregrp.com/
ArcSight Product Documentation https://community.softwaregrp.com/t5/ArcSight-Product-Documentation/ct-p/productdocs
Micro Focus ESM Service Layer 7.6 Page 2 of 2

ESM Service Layer: Core Services 2.0 Page 2
Package
com.arcsight.coma.bridge

Class AuthenticationException
java.lang.Object
|
+-java.lang.Throwable
|
+-java.lang.Exception
|
+-com.arcsight.coma.bridge.AuthenticationException
All Implemented Interfaces:
Serializable
public class AuthenticationException

extends Exception
Constructor Summary
public AuthenticationException(String message)
public AuthenticationException(String service, String method)
Methods inherited from class java.lang.Throwable
addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage,

getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace,
printStackTrace, setStackTrace, toString
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Constructors
AuthenticationException
public AuthenticationException(String message)
public AuthenticationException(String service,
String method)

Class AuthorizationException
java.lang.Object
|
|
|
+-com.arcsight.coma.bridge.AuthorizationException
Serializable
public class AuthorizationException

extends Exception
Constructor Summary
public AuthorizationException(String message)
public AuthorizationException(String service, String method, boolean

classRequiresAuthentication, boolean methodRequiresAuthentication,
String[] classRequiredRights, String[] methodRequiredRights)

Constructors
AuthorizationException
public AuthorizationException(String message)
(continued on next page)

AuthorizationException
public AuthorizationException(String service,
String method,
boolean classRequiresAuthentication,
boolean methodRequiresAuthentication,
String[] classRequiredRights,
String[] methodRequiredRights)

Package
com.arcsight.coma.client.gwt

com.arcsight.coma.client.gwt
Class RemoteServiceException
java.lang.Object
|
|
|
+-com.arcsight.coma.client.gwt.RemoteServiceException
Serializable, Serializable
public class RemoteServiceException

extends Exception
implements Serializable, Serializable
Copyright (c) 2001-2018 Micro Focus or one of its affiliates. Confidential commercial computer software. Valid license required.
Field Summary
public static final ERROR_UNKNOWN
Value: -54188
Constructor Summary
public RemoteServiceException()
public RemoteServiceException(String message, Throwable cause)
public RemoteServiceException(String message)
public RemoteServiceException(Throwable cause)
Method Summary
int getErrorCode()
String getRemoteStacktrace()
void setErrorCode(int errorCode)
void setRemoteStacktrace(String remoteStacktrace)

Fields
ERROR_UNKNOWN
public static final int ERROR_UNKNOWN
Constant value: -54188
Constructors
RemoteServiceException
public RemoteServiceException()
public RemoteServiceException(String message,
Throwable cause)
public RemoteServiceException(String message)
public RemoteServiceException(Throwable cause)
Methods
getRemoteStacktrace
public String getRemoteStacktrace()

setRemoteStacktrace
public void setRemoteStacktrace(String remoteStacktrace)
getErrorCode
public int getErrorCode()
setErrorCode
public void setErrorCode(int errorCode)

Package
com.arcsight.product.core.service.v1.axis2.
jaxws

com.arcsight.product.core.service.v1.axis2.jaxws
Class AuthenticationExceptionBean
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.AuthenticationExceptionBean
public class AuthenticationExceptionBean

extends Object
This class was generated by the JAX-WS RI. JAX-WS RI 2.3.0 Generated source version: 2.3.0
Constructor Summary
public AuthenticationExceptionBean()
Method Summary
String getMessage()
void setMessage(String message)
Constructors
AuthenticationExceptionBean
public AuthenticationExceptionBean()
Methods
getMessage
public String getMessage()
Returns:
returns String

setMessage
public void setMessage(String message)
Parameters:
message - the value for the message property

Class AuthorizationExceptionBean
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.AuthorizationExceptionBean
public class AuthorizationExceptionBean

extends Object
Constructor Summary
public AuthorizationExceptionBean()
Method Summary
String getMessage()
Constructors
AuthorizationExceptionBean
public AuthorizationExceptionBean()
Methods
getMessage
Returns:
returns String

setMessage
Parameters:

Class GetAllRightsByGroupTypeResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.GetAllRightsByGroupTypeResponse
public class GetAllRightsByGroupTypeResponse

extends Object
Constructor Summary
public GetAllRightsByGroupTypeResponse()
Method Summary
HashMap getReturn()
void setReturn(HashMap _return)
Constructors
GetAllRightsByGroupTypeResponse
public GetAllRightsByGroupTypeResponse()
Methods
getReturn
public HashMap getReturn()
Returns:
returns HashMap>

setReturn
public void setReturn(HashMap _return)
Parameters:
_return - the value for the _return property

Class LoginServiceAuthenticate
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceAuthenticate
public class LoginServiceAuthenticate

extends Object
Constructor Summary
public LoginServiceAuthenticate()
Method Summary
AuthContext getAuthContext()
String getAuthToken()
PasswordCredential getCred()
void setAuthContext(AuthContext authContext)
void setAuthToken(String authToken)
void setCred(PasswordCredential cred)
Constructors
LoginServiceAuthenticate
public LoginServiceAuthenticate()
Methods

getAuthToken
public String getAuthToken()
Returns:
returns String
setAuthToken
public void setAuthToken(String authToken)
Parameters:
authToken - the value for the authToken property
getCred
public PasswordCredential getCred()
Returns:
returns PasswordCredential
setCred
public void setCred(PasswordCredential cred)
Parameters:
cred - the value for the cred property
getAuthContext
public AuthContext getAuthContext()
Returns:
returns AuthContext
setAuthContext
public void setAuthContext(AuthContext authContext)
Parameters:
authContext - the value for the authContext property

Class LoginServiceAuthenticateOSPCredential
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceAuthenticateOSPCredential
public class LoginServiceAuthenticateOSPCredential

extends Object
Constructor Summary
public LoginServiceAuthenticateOSPCredential()
Method Summary
Constructors
LoginServiceAuthenticateOSPCredential
public LoginServiceAuthenticateOSPCredential()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceAuthenticateOSPCredentialResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceAuthenticateOSPCredentialResp
onse
public class LoginServiceAuthenticateOSPCredentialResponse

extends Object
Constructor Summary
public LoginServiceAuthenticateOSPCredentialResponse()
Method Summary
AuthResponse getReturn()
void setReturn(AuthResponse _return)
Constructors
LoginServiceAuthenticateOSPCredentialResponse
public LoginServiceAuthenticateOSPCredentialResponse()
Methods
getReturn
public AuthResponse getReturn()
Returns:
returns AuthResponse

setReturn
public void setReturn(AuthResponse _return)
Parameters:

Class LoginServiceAuthenticateResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceAuthenticateResponse
public class LoginServiceAuthenticateResponse

extends Object
Constructor Summary
public LoginServiceAuthenticateResponse()
Method Summary
Constructors
LoginServiceAuthenticateResponse
public LoginServiceAuthenticateResponse()
Methods
getReturn
Returns:

setReturn
Parameters:

Class LoginServiceGetAuthenticationMethod
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetAuthenticationMethod
public class LoginServiceGetAuthenticationMethod

extends Object
Constructor Summary
public LoginServiceGetAuthenticationMethod()
Method Summary
Constructors
LoginServiceGetAuthenticationMethod
public LoginServiceGetAuthenticationMethod()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetAuthenticationMethodResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetAuthenticationMethodRespon
se
public class LoginServiceGetAuthenticationMethodResponse

extends Object
Constructor Summary
public LoginServiceGetAuthenticationMethodResponse()
Method Summary
AuthMethod getReturn()
void setReturn(AuthMethod _return)
Constructors
LoginServiceGetAuthenticationMethodResponse
public LoginServiceGetAuthenticationMethodResponse()
Methods
getReturn
public AuthMethod getReturn()
Returns:
returns AuthMethod

setReturn
public void setReturn(AuthMethod _return)
Parameters:

Class LoginServiceGetCurrentUser
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetCurrentUser
public class LoginServiceGetCurrentUser

extends Object
Constructor Summary
public LoginServiceGetCurrentUser()
Method Summary
Constructors
LoginServiceGetCurrentUser
public LoginServiceGetCurrentUser()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetCurrentUserResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetCurrentUserResponse
public class LoginServiceGetCurrentUserResponse

extends Object
Constructor Summary
public LoginServiceGetCurrentUserResponse()
Method Summary
User getReturn()
void setReturn(User _return)
Constructors
LoginServiceGetCurrentUserResponse
public LoginServiceGetCurrentUserResponse()
Methods
getReturn
public User getReturn()
Returns:
returns User

setReturn
public void setReturn(User _return)
Parameters:

Class LoginServiceGetOSPSettings
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetOSPSettings
public class LoginServiceGetOSPSettings

extends Object
Constructor Summary
public LoginServiceGetOSPSettings()
Method Summary
Constructors
LoginServiceGetOSPSettings
public LoginServiceGetOSPSettings()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetOSPSettingsResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetOSPSettingsResponse
public class LoginServiceGetOSPSettingsResponse

extends Object
Constructor Summary
public LoginServiceGetOSPSettingsResponse()
Method Summary
String getReturn()
void setReturn(String _return)
Constructors
LoginServiceGetOSPSettingsResponse
public LoginServiceGetOSPSettingsResponse()
Methods
getReturn
public String getReturn()
Returns:
returns String

setReturn
public void setReturn(String _return)
Parameters:

Class LoginServiceGetServiceMajorVersion
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetServiceMajorVersion
public class LoginServiceGetServiceMajorVersion

extends Object
Constructor Summary
public LoginServiceGetServiceMajorVersion()
Method Summary
Constructors
LoginServiceGetServiceMajorVersion
public LoginServiceGetServiceMajorVersion()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetServiceMajorVersionResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetServiceMajorVersionRespons
e
public class LoginServiceGetServiceMajorVersionResponse

extends Object
Constructor Summary
public LoginServiceGetServiceMajorVersionResponse()
Method Summary
int getReturn()
void setReturn(int _return)
Constructors
LoginServiceGetServiceMajorVersionResponse
public LoginServiceGetServiceMajorVersionResponse()
Methods
getReturn
public int getReturn()
Returns:
returns int

setReturn
public void setReturn(int _return)
Parameters:

Class LoginServiceGetServiceMinorVersion
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetServiceMinorVersion
public class LoginServiceGetServiceMinorVersion

extends Object
Constructor Summary
public LoginServiceGetServiceMinorVersion()
Method Summary
Constructors
LoginServiceGetServiceMinorVersion
public LoginServiceGetServiceMinorVersion()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetServiceMinorVersionResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetServiceMinorVersionRespons
e
public class LoginServiceGetServiceMinorVersionResponse

extends Object
Constructor Summary
public LoginServiceGetServiceMinorVersionResponse()
Method Summary
int getReturn()
void setReturn(int _return)
Constructors
LoginServiceGetServiceMinorVersionResponse
public LoginServiceGetServiceMinorVersionResponse()
Methods
getReturn
public int getReturn()
Returns:
returns int

setReturn
public void setReturn(int _return)
Parameters:

Class LoginServiceGetSession
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetSession
public class LoginServiceGetSession

extends Object
Constructor Summary
public LoginServiceGetSession()
Method Summary
Constructors
LoginServiceGetSession
public LoginServiceGetSession()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceGetSessionResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceGetSessionResponse
public class LoginServiceGetSessionResponse

extends Object
Constructor Summary
public LoginServiceGetSessionResponse()
Method Summary
Session getReturn()
void setReturn(Session _return)
Constructors
LoginServiceGetSessionResponse
public LoginServiceGetSessionResponse()
Methods
getReturn
public Session getReturn()
Returns:
returns Session

setReturn
public void setReturn(Session _return)
Parameters:

Class LoginServiceIsCASAuth
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceIsCASAuth
public class LoginServiceIsCASAuth

extends Object
Constructor Summary
public LoginServiceIsCASAuth()
Method Summary
Constructors
LoginServiceIsCASAuth
public LoginServiceIsCASAuth()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceIsCASAuthResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceIsCASAuthResponse
public class LoginServiceIsCASAuthResponse

extends Object
Constructor Summary
public LoginServiceIsCASAuthResponse()
Method Summary
boolean isReturn()
void setReturn(boolean _return)
Constructors
LoginServiceIsCASAuthResponse
public LoginServiceIsCASAuthResponse()
Methods
isReturn
public boolean isReturn()
Returns:
returns boolean

setReturn
public void setReturn(boolean _return)
Parameters:

Class LoginServiceLogin
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLogin
public class LoginServiceLogin

extends Object
Constructor Summary
public LoginServiceLogin()
Method Summary
String getLogin()
String getPassword()
void setLogin(String login)
void setPassword(String password)
Constructors
LoginServiceLogin
public LoginServiceLogin()
Methods

getAuthToken
Returns:
returns String
setAuthToken
Parameters:
getLogin
public String getLogin()
Returns:
returns String
setLogin
public void setLogin(String login)
Parameters:
login - the value for the login property
getPassword
public String getPassword()
Returns:
returns String
setPassword
public void setPassword(String password)
Parameters:
password - the value for the password property

Class LoginServiceLoginForOneTimeUse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLoginForOneTimeUse
public class LoginServiceLoginForOneTimeUse

extends Object
Constructor Summary
public LoginServiceLoginForOneTimeUse()
Method Summary
String getLogin()
Constructors
LoginServiceLoginForOneTimeUse
public LoginServiceLoginForOneTimeUse()
Methods

getAuthToken
Returns:
returns String
setAuthToken
Parameters:
getLogin
Returns:
returns String
setLogin
Parameters:
getPassword
Returns:
returns String
setPassword
Parameters:
password - the value for the password property

Class LoginServiceLoginForOneTimeUseResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLoginForOneTimeUseResponse
public class LoginServiceLoginForOneTimeUseResponse

extends Object
Constructor Summary
public LoginServiceLoginForOneTimeUseResponse()
Method Summary
String getReturn()
Constructors
LoginServiceLoginForOneTimeUseResponse
public LoginServiceLoginForOneTimeUseResponse()
Methods
getReturn
Returns:
returns String

setReturn
Parameters:

Class LoginServiceLoginResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLoginResponse
public class LoginServiceLoginResponse

extends Object
Constructor Summary
public LoginServiceLoginResponse()
Method Summary
String getReturn()
Constructors
LoginServiceLoginResponse
public LoginServiceLoginResponse()
Methods
getReturn
Returns:
returns String

setReturn
Parameters:

Class LoginServiceLogout
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLogout
public class LoginServiceLogout

extends Object
Constructor Summary
public LoginServiceLogout()
Method Summary
Constructors
LoginServiceLogout
public LoginServiceLogout()
Methods
getAuthToken
Returns:
returns String

setAuthToken
Parameters:

Class LoginServiceLogoutResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceLogoutResponse
public class LoginServiceLogoutResponse

extends Object
Constructor Summary
public LoginServiceLogoutResponse()
Method Summary
Void getReturn()
void setReturn(Void _return)
Constructors
LoginServiceLogoutResponse
public LoginServiceLogoutResponse()
Methods
getReturn
public Void getReturn()
Returns:
returns Void

setReturn
public void setReturn(Void _return)
Parameters:

Class LoginServiceResetPassword
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceResetPassword
public class LoginServiceResetPassword

extends Object
Constructor Summary
public LoginServiceResetPassword()
Method Summary
String getLogin()
Constructors
LoginServiceResetPassword
public LoginServiceResetPassword()
Methods
getAuthToken
Returns:

returns String
setAuthToken
Parameters:
getLogin
Returns:
returns String
setLogin
Parameters:

Class LoginServiceResetPasswordResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceResetPasswordResponse
public class LoginServiceResetPasswordResponse

extends Object
Constructor Summary
public LoginServiceResetPasswordResponse()
Method Summary
Void getReturn()
void setReturn(Void _return)
Constructors
LoginServiceResetPasswordResponse
public LoginServiceResetPasswordResponse()
Methods
getReturn
public Void getReturn()
Returns:
returns Void

setReturn
public void setReturn(Void _return)
Parameters:

Class LoginServiceSendAuthChallengeResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceSendAuthChallengeResponse
public class LoginServiceSendAuthChallengeResponse

extends Object
Constructor Summary
public LoginServiceSendAuthChallengeResponse()
Method Summary
int getChallengeId()
String getResp()
void setChallengeId(int challengeId)
void setResp(String resp)
Constructors
LoginServiceSendAuthChallengeResponse
public LoginServiceSendAuthChallengeResponse()
Methods

getAuthToken
Returns:
returns String
setAuthToken
Parameters:
getChallengeId
public int getChallengeId()
Returns:
returns int
setChallengeId
public void setChallengeId(int challengeId)
Parameters:
challengeId - the value for the challengeId property
getResp
public String getResp()
Returns:
returns String
setResp
public void setResp(String resp)
Parameters:
resp - the value for the resp property

Class LoginServiceSendAuthChallengeResponseResponse
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.axis2.jaxws.LoginServiceSendAuthChallengeResponseResp
onse
public class LoginServiceSendAuthChallengeResponseResponse

extends Object
Constructor Summary
public LoginServiceSendAuthChallengeResponseResponse()
Method Summary
Constructors
LoginServiceSendAuthChallengeResponseResponse
public LoginServiceSendAuthChallengeResponseResponse()
Methods
getReturn
Returns:

setReturn
Parameters:

Class ModelLoader
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.ModelLoader
public final class ModelLoader

extends Object
Constructor Summary
public ModelLoader()
Constructors
ModelLoader
public ModelLoader()

Class ObjectFactory
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.ObjectFactory
public final class ObjectFactory

extends Object
Constructor Summary
public ObjectFactory()
Constructors
ObjectFactory

Class ServiceExceptionBean
java.lang.Object
|
+-com.arcsight.product.core.service.v1.axis2.jaxws.ServiceExceptionBean
public class ServiceExceptionBean

extends Object
Constructor Summary
public ServiceExceptionBean()
Method Summary
int getErrorCode()
String getMessage()
Constructors
ServiceExceptionBean
public ServiceExceptionBean()
Methods
getErrorCode

Returns:
returns int
setErrorCode
Parameters:
errorCode - the value for the errorCode property
getMessage
Returns:
returns String
setMessage
Parameters:

Package
com.arcsight.product.core.service.v1.mode
l

com.arcsight.product.core.service.v1.model
Class AuthContext
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.AuthContext
CoreServiceModel
public class AuthContext

extends Object
implements CoreServiceModel
Constructor Summary
public AuthContext()
Constructor
Method Summary
Boolean getFallback()
Tests whether this authContext is fallen back or not.
void setFallback(Boolean fallback)

Sets whether this authContext is fallen back.
Constructors
AuthContext
public AuthContext()
Constructor
Methods
getFallback
public Boolean getFallback()
Tests whether this authContext is fallen back or not.

Returns:
True if this authContext is fallen back.
setFallback
public void setFallback(Boolean fallback)
Sets whether this authContext is fallen back.
Parameters:
fallback - If true, this authContext is fallen back.

Class AuthMethod
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.AuthMethod
CoreServiceModel
public class AuthMethod

extends Object
Description of authentication method. Available methods are provided to the user, so that he/she could decide which method to use
to connect to the server.
JSON prototype
Field Summary
public static final BUILTIN
public static final OSP
public static final PKI
public static final PKI_AND_LOCAL_PASSWORD
public static final PKI_WITH_PASSWORD_BACKUP
public static final RADIUS
public static final RADIUS_WITH_PASSWORD_BACKUP
Constructor Summary
public AuthMethod()
Constructor
public AuthMethod(boolean localPassword, boolean externalUserId)
Method Summary
boolean isExternalUserId()
Tests whether this authMethod has external user Id.

boolean isLocalPassword()
Tests whether this AuthMethod has local password.
void setExternalUserId(boolean externalUserId)

Sets whether this authMethod has external user Id.
void setLocalPassword(boolean localPassword)

Sets whether this AuthMethod has local password.
Fields
BUILTIN
public static final com.arcsight.product.core.service.v1.model.AuthMethod BUILTIN
PKI
public static final com.arcsight.product.core.service.v1.model.AuthMethod PKI
RADIUS
public static final com.arcsight.product.core.service.v1.model.AuthMethod RADIUS
PKI_AND_LOCAL_PASSWORD
public static final com.arcsight.product.core.service.v1.model.AuthMethod
PKI_AND_LOCAL_PASSWORD
PKI_WITH_PASSWORD_BACKUP
PKI_WITH_PASSWORD_BACKUP
RADIUS_WITH_PASSWORD_BACKUP
RADIUS_WITH_PASSWORD_BACKUP

OSP
public static final com.arcsight.product.core.service.v1.model.AuthMethod OSP
Constructors
AuthMethod
public AuthMethod()
Constructor
AuthMethod
public AuthMethod(boolean localPassword,
boolean externalUserId)
Methods
isLocalPassword
public boolean isLocalPassword()
Tests whether this AuthMethod has local password.
Returns:
True if this AuthMethod has local password.
setLocalPassword
public void setLocalPassword(boolean localPassword)
Sets whether this AuthMethod has local password.
Parameters:
localPassword - the localPassword to set
isExternalUserId
public boolean isExternalUserId()
Tests whether this authMethod has external user Id.
Returns:
True if this authMethod has external user Id.

setExternalUserId
public void setExternalUserId(boolean externalUserId)
Sets whether this authMethod has external user Id.
Parameters:
externalUserId - IF true, this authMethod has external user Id.

Class AuthResponse
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.AuthResponse
CoreServiceModel
public class AuthResponse

extends Object
Constructor Summary
public AuthResponse()
Constructor
public AuthResponse(String authToken)

Constructor
Method Summary
Gets the string value of authToken.
User getUser()
Returns the user being authenticated.
boolean isPasswordChangeRequired()
Gets whether or not the user must change their password.
boolean isPasswordExpiring()
Notifies user that password is expiring soon.

Sets the string value of authToken.
void setPasswordExpiring(boolean passwordExpiring)

Sets whether password is expiring soon.
void setUser(User user)

Sets the user being authenticated.

Constructors
AuthResponse
public AuthResponse()
Constructor
AuthResponse
public AuthResponse(String authToken)
Constructor
Parameters:
authToken - The string value of authToken.
Methods
getAuthToken
Returns:
The string value of authToken.
setAuthToken
Parameters:
authToken - the string value authToken to set
getUser
public User getUser()
Returns the user being authenticated.
Returns:
User being authenticated.
setUser
public void setUser(User user)
Sets the user being authenticated.

Parameters:
user - The user being authenticated.
isPasswordExpiring
public boolean isPasswordExpiring()
Notifies user that password is expiring soon.
Returns:
True if password is expiring soon.
setPasswordExpiring
public void setPasswordExpiring(boolean passwordExpiring)
Sets whether password is expiring soon.
Parameters:
passwordExpiring - If true, password is expiring soon.
isPasswordChangeRequired
public boolean isPasswordChangeRequired()
Gets whether or not the user must change their password.
Returns:
True if the user must change their password.

Class Credential
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Credential
CoreServiceModel
Direct Known Subclasses:

PasswordCredential
public class Credential

extends Object
Constructor Summary
public Credential()
Method Summary
String getUserName()
void setUserName(String userName)
Constructors
Credential
public Credential()
Methods
getUserName
public String getUserName()

Returns:
the userName
setUserName
public void setUserName(String userName)
Parameters:
userName - the userName to set

Class Group
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Group
CoreServiceModel
public class Group

extends Object
Description of a Group of Users.
JSON prototype
Constructor Summary
public Group()
Method Summary
String getDescription()
long getId()
boolean getIsDefault()
String getName()
Long[] getRightIds()
GroupType getType()
Long[] getUserIds()
void setDescription(String description)
void setId(long id)
void setIsDefault(boolean isDefault)
void setName(String name)

void setRightIds(Long[] rightIds)
void setType(GroupType type)
void setUserIds(Long[] userIds)
Constructors
Group
public Group()
Methods
getId
public long getId()
getRightIds
public Long[] getRightIds()
setRightIds
public void setRightIds(Long[] rightIds)
getUserIds
public Long[] getUserIds()
setUserIds
public void setUserIds(Long[] userIds)

setId
public void setId(long id)
getType
public GroupType getType()
setType
public void setType(GroupType type)
getName
public String getName()
setName
public void setName(String name)
getDescription
public String getDescription()
setDescription
public void setDescription(String description)
getIsDefault
public boolean getIsDefault()
setIsDefault
public void setIsDefault(boolean isDefault)

Class GroupType
java.lang.Object
|
+-java.lang.Enum
|
+-com.arcsight.product.core.service.v1.model.GroupType
Serializable, Comparable
public final class GroupType

extends Enum
Different types of groups that can be created.
Field Summary
public static final CONAPP_RIGHTS
public static final LOGGER_REPORT
public static final LOGGER_RIGHTS
public static final LOGGER_SEARCH
public static final SYSTEM_ADMIN
Method Summary
String getDbName()
static GroupType valueOf(String name)
static GroupType[] values()
Methods inherited from class java.lang.Enum
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
Methods inherited from interface java.lang.Comparable

compareTo
Fields
SYSTEM_ADMIN
public static final com.arcsight.product.core.service.v1.model.GroupType SYSTEM_ADMIN
LOGGER_RIGHTS
public static final com.arcsight.product.core.service.v1.model.GroupType LOGGER_RIGHTS
LOGGER_REPORT
public static final com.arcsight.product.core.service.v1.model.GroupType LOGGER_REPORT
LOGGER_SEARCH
public static final com.arcsight.product.core.service.v1.model.GroupType LOGGER_SEARCH
CONAPP_RIGHTS
public static final com.arcsight.product.core.service.v1.model.GroupType CONAPP_RIGHTS
Methods
values
public static GroupType[] values()
valueOf
public static GroupType valueOf(String name)

getDbName
public String getDbName()

Class LoginCookieType
java.lang.Object
|
+-java.lang.Enum
|
+-com.arcsight.product.core.service.v1.model.LoginCookieType
public final class LoginCookieType

extends Enum
Field Summary
public static final ESM
public static final PLATFORM
Method Summary
static valueOf(String name)
LoginCookieType
static values()
LoginCookieType[]
compareTo
Fields
ESM
public static final com.arcsight.product.core.service.v1.model.LoginCookieType ESM

PLATFORM
public static final com.arcsight.product.core.service.v1.model.LoginCookieType PLATFORM
Methods
values
public static LoginCookieType[] values()
valueOf
public static LoginCookieType valueOf(String name)

Class PasswordComplexityRequirement
java.lang.Object
|
+-java.lang.Enum
|
+-com.arcsight.product.core.service.v1.model.PasswordComplexityRequirement
public final class PasswordComplexityRequirement

extends Enum
Different types of complexity requirements that may be imposed when a user is changing their password.
Field Summary
public static final MAXIMUM_LENGTH
...
public static final MINIMUM_DIFFERENCE

...
public static final MINIMUM_LENGTH

is the password at least a minimum length ...
public static final MINIMUM_LOWER_CASE

...
public static final MINIMUM_NUMERIC

...
public static final MINIMUM_SPECIAL_CHARACTERS

...
public static final MINIMUM_UPPER_CASE

...
Method Summary
static valueOf(String name)
PasswordComplexityReq
uirement
static values()
PasswordComplexityReq
uirement[]

compareTo
Fields
MINIMUM_LENGTH
public static final
com.arcsight.product.core.service.v1.model.PasswordComplexityRequirement MINIMUM_LENGTH
is the password at least a minimum length ...
MAXIMUM_LENGTH
public static final
com.arcsight.product.core.service.v1.model.PasswordComplexityRequirement MAXIMUM_LENGTH
... at most a maximum length ...
MINIMUM_NUMERIC
public static final
com.arcsight.product.core.service.v1.model.PasswordComplexityRequirement MINIMUM_NUMERIC
... have a minimum number of numeric characters ...
MINIMUM_UPPER_CASE
public static final
com.arcsight.product.core.service.v1.model.PasswordComplexityRequirement
MINIMUM_UPPER_CASE
... have a minimum number of upper-case characters ...
MINIMUM_LOWER_CASE
public static final
MINIMUM_LOWER_CASE
... have a minimum number of lower-case characters ...
MINIMUM_SPECIAL_CHARACTERS
public static final
MINIMUM_SPECIAL_CHARACTERS

... have a minimum number of special characters ...
MINIMUM_DIFFERENCE
public static final
MINIMUM_DIFFERENCE
... at least a certain number of characters different from the old password
Methods
values
public static PasswordComplexityRequirement[] values()
valueOf
public static PasswordComplexityRequirement valueOf(String name)

Class PasswordCredential
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Credential
|
+-com.arcsight.product.core.service.v1.model.PasswordCredential
CoreServiceModel, CoreServiceModel
public class PasswordCredential

extends Credential
implements CoreServiceModel, CoreServiceModel
Constructor Summary
public PasswordCredential()
Constructor.
public PasswordCredential(String userName, String password)

Constructor.
Method Summary
Gets the password of the login user.

Sets the password for the login user.
Methods inherited from class com.arcsight.product.core.service.v1.model.Credential
getUserName, setUserName
Constructors
PasswordCredential
public PasswordCredential()
Constructor.

PasswordCredential
public PasswordCredential(String userName,
String password)
Constructor.
Parameters:
userName - The login name of the login user.
password - The password of the login user.
Methods
getPassword
Gets the password of the login user.
Returns:
the password
setPassword
Sets the password for the login user.
Parameters:
password - The password to set.

Class PasswordRequirement
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.PasswordRequirement
CoreServiceModel
public class PasswordRequirement

extends Object
Requirements for new passwords.
JSON prototype
Constructor Summary
public PasswordRequirement()
Method Summary
PasswordComplexityReq getRequirement()
uirement
Integer getValue()
void setRequirement(PasswordComplexityRequirement requirement)
void setValue(Integer value)
Constructors
PasswordRequirement
public PasswordRequirement()
Methods

getRequirement
public PasswordComplexityRequirement getRequirement()
setRequirement
public void setRequirement(PasswordComplexityRequirement requirement)
getValue
public Integer getValue()
setValue
public void setValue(Integer value)

Class Right
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Right
CoreServiceModel
public class Right

extends Object
DESCRIBE ME
JSON prototype
Constructor Summary
public Right()
Method Summary
String getCategory()
String getDescription()
long getId()
String getModule()
String getName()
String getType()
void setCategory(String category)
void setDescription(String description)
void setId(long id)
void setModule(String module)
void setName(String name)

void setType(String type)
Constructors
Right
public Right()
Methods
getId
public long getId()
setId
public void setId(long id)
getType
public String getType()
setType
public void setType(String type)
getModule
public String getModule()
setModule
public void setModule(String module)

getName
public String getName()
setName
public void setName(String name)
getDescription
public String getDescription()
setDescription
public void setDescription(String description)
getCategory
public String getCategory()
setCategory
public void setCategory(String category)

Class ScheduledWorkPeriod
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.ScheduledWorkPeriod
CoreServiceModel
public class ScheduledWorkPeriod

extends Object
Description of scheduled work period.
JSON prototype
Constructor Summary
public ScheduledWorkPeriod()
Method Summary
Workday getDayOfWeek()
Get the dayOfWeek.
Time getEndTime()
Get the endTime.
Long getId()
Get the id.
Time getStartTime()
Get the startTime.
void setDayOfWeek(Workday dayOfWeek)

Set the dayOfWeek.
void setEndTime(Time endTime)

Set the endTime.
void setId(Long id)

Set the id.
void setStartTime(Time startTime)

Set the startTime.
String toString()

Constructors
ScheduledWorkPeriod
public ScheduledWorkPeriod()
Methods
getId
public Long getId()
Get the id.
Returns:
the id
setId
public void setId(Long id)
Set the id.
Parameters:
id - the id to set
getDayOfWeek
public Workday getDayOfWeek()
Get the dayOfWeek.
Returns:
the dayOfWeek
setDayOfWeek
public void setDayOfWeek(Workday dayOfWeek)
Set the dayOfWeek.
Parameters:
dayOfWeek - the dayOfWeek to set

getStartTime
public Time getStartTime()
Get the startTime.
Returns:
the startTime
setStartTime
public void setStartTime(Time startTime)
Set the startTime.
Parameters:
startTime - the startTime to set
getEndTime
public Time getEndTime()
Get the endTime.
Returns:
the endTime
setEndTime
public void setEndTime(Time endTime)
Set the endTime.
Parameters:
endTime - the endTime to set
toString
public String toString()

Class Session
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Session
CoreServiceModel
public class Session

extends Object
DESCRIBE ME
JSON prototype
Constructor Summary
public Session()
Method Summary
long getCreationMillis()
Gets the long value of creation time in millisecond of this session.
long getExpirationMillis()
Gets the long value of expiration time in millisecond of this session.
long getUserId()
Gets the ID of the login user in this session.

void setCreationMillis(long creationMillis)

Sets the long value of creation time in millisecond of this session.
void setExpirationMillis(long expirationMillis)

Sets the long value of expiration time in millisecond of this session.
void setUserId(long userId)

Sets the ID of the login user in this session.

Constructors
Session
public Session()
Methods
getAuthToken
Returns:
The string value of authToken.
setAuthToken
Parameters:
authToken - The string value of authToken.
getUserId
public long getUserId()
Gets the ID of the login user in this session.
Returns:
The ID of the login user.
setUserId
public void setUserId(long userId)
Sets the ID of the login user in this session.
Parameters:
userId - The ID of login user.
getCreationMillis
public long getCreationMillis()
Gets the long value of creation time in millisecond of this session.

Returns:
The long value of creation time in millisecond of this session.
setCreationMillis
public void setCreationMillis(long creationMillis)
Sets the long value of creation time in millisecond of this session.
Parameters:
creationMillis - The long value of creation time in millisecond of this session.
getExpirationMillis
public long getExpirationMillis()
Gets the long value of expiration time in millisecond of this session.
Returns:
The long value of expiration time in millisecond of this session.
setExpirationMillis
public void setExpirationMillis(long expirationMillis)
Sets the long value of expiration time in millisecond of this session.
Parameters:
expirationMillis - The long value of expiration time in millisecond of this session.

Class Time
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.Time
CoreServiceModel
public class Time

extends Object
DESCRIBE ME
JSON prototype
Constructor Summary
public Time()
Method Summary
int getHour()
Get the hour.
int getMinutes()
Get the minutes.
void setHour(int hour)

Set the hour.
void setMinutes(int minutes)

Set the minutes.
Constructors
Time
public Time()

Methods
getHour
public int getHour()
Get the hour.
Returns:
the hour
setHour
public void setHour(int hour)
Set the hour.
Parameters:
hour - the hour to set
getMinutes
public int getMinutes()
Get the minutes.
Returns:
the minutes
setMinutes
public void setMinutes(int minutes)
Set the minutes.
Parameters:
minutes - the minutes to set

Class User
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.User
CoreServiceModel
public class User

extends Object
DESCRIBE ME
JSON prototype
Constructor Summary
public User()
Constructor
Method Summary
String getDepartment()
Gets the department of this user.
String getEmail()
Gets the email of this user.
String getExternalLoginId()
Get the external login Id of this user.
String getFax()
Gets the fax information of this user.
String getFirstName()
Gets the first name of this user.
String[] getGroupIds()
Gets the IDs of the groups which this user is/was in.
Long getId()
Gets the ID of this user.
Boolean getIsActive()
Tests whether this user is active.
boolean getIsDefault()

String getLastName()
Gets the last name of this user.
String getLogin()
Gets the login name of this user.
boolean getMustChangePassword()
Tests whether the password is required to change.
String getNotes()
Gets the notes of this user.
String getPagerNumber()
Gets the pager number of this user.
Gets the password of this user.
String getPhone()
Gets the phone number of this user.
List getScheduledWorkPeriods()
Gets the list of scheduled work periods for this user.
String getTitle()
Gets the title of this user.
boolean isLocked()
Tests whether this user is locked.
void setDepartment(String department)

Sets the department of this user.
void setEmail(String email)

Sets the email of this user.
void setExternalLoginId(String externalLoginId)

Set the external login Id of this user.
void setFax(String fax)

Sets the fax information of this user.
void setFirstName(String firstName)

Sets the first name of this user.
void setGroupIds(String[] groupIds)

Sets the ID of the group which this user is in.
void setId(Long id)

Sets the ID of this user.
void setIsActive(Boolean isActive)

Sets whether this user is active.
void setIsDefault(boolean isDefault)

void setLastName(String lastName)
Sets the last name of this user.
void setLocked(boolean locked)

Sets whether this user is locked.

Sets the login name of this user.
void setMustChangePassword(boolean mustChangePassword)

Sets whether the password is required to change.
void setNotes(String notes)

Sets the notes of this user.
void setPagerNumber(String pagerNumber)

Sets the pager number of this user.

Sets the password of this user.
void setPhone(String phone)

Sets the phone number of this user.
void setScheduledWorkPeriods(List scheduledWorkPeriods)

Set the list of scheduled work periods.
void setTitle(String title)

Sets the title of this user.
Constructors
User
public User()
Constructor
Methods
getId
public Long getId()
Gets the ID of this user.
Returns:
ID of this user.

setId
public void setId(Long id)
Sets the ID of this user.
Parameters:
id - of this user.
getGroupIds
public String[] getGroupIds()
Gets the IDs of the groups which this user is/was in.
Returns:
IDs of the groups which this user is/was in.
setGroupIds
public void setGroupIds(String[] groupIds)
Sets the ID of the group which this user is in.
Parameters:
groupIds - ID of the group which this user is in.
getLogin
Gets the login name of this user.
Returns:
The login name of this user.
setLogin
Sets the login name of this user.
Parameters:
login - The login name of this user.
getFirstName
public String getFirstName()
Gets the first name of this user.
Returns:
The first name of this user.

setFirstName
public void setFirstName(String firstName)
Sets the first name of this user.
Parameters:
firstName - The first name of this user.
getLastName
public String getLastName()
Gets the last name of this user.
Returns:
The last name of this user.
setLastName
public void setLastName(String lastName)
Sets the last name of this user.
Parameters:
lastName - The last name of this user.
getEmail
public String getEmail()
Gets the email of this user.
Returns:
The email of this user.
setEmail
public void setEmail(String email)
Sets the email of this user.
Parameters:
email - The email of this user.
setPassword
Sets the password of this user.
Parameters:
password - The password of this user.

getIsActive
public Boolean getIsActive()
Tests whether this user is active.
Returns:
True if this user is active.
setIsActive
public void setIsActive(Boolean isActive)
Sets whether this user is active.
Parameters:
isActive - If true, this user is active.
getPhone
public String getPhone()
Gets the phone number of this user.
Returns:
The phone number of this user.
setPhone
public void setPhone(String phone)
Sets the phone number of this user.
Parameters:
phone - The phone number of this user.
getIsDefault
public boolean getIsDefault()
setIsDefault
public void setIsDefault(boolean isDefault)
getPassword
Gets the password of this user. NOTE: for API - business layer mapping only; not expected to be used by clients.

Returns:
The password of this user.
getExternalLoginId
public String getExternalLoginId()
Get the external login Id of this user.
Returns:
The external login Id of this user.
setExternalLoginId
public void setExternalLoginId(String externalLoginId)
Set the external login Id of this user.
Parameters:
externalLoginId - The external login Id to set for this user.
getMustChangePassword
public boolean getMustChangePassword()
Tests whether the password is required to change.
Returns:
True if the password is required to change.
setMustChangePassword
public void setMustChangePassword(boolean mustChangePassword)
Sets whether the password is required to change.
Parameters:
mustChangePassword - If true, the password is required to change.
getScheduledWorkPeriods
public List getScheduledWorkPeriods()
Gets the list of scheduled work periods for this user.
Returns:
The list of scheduled work periods.
setScheduledWorkPeriods
public void setScheduledWorkPeriods(List scheduledWorkPeriods)
Set the list of scheduled work periods.

Parameters:
scheduledWorkPeriods - The list of scheduled work periods to set
getTitle
public String getTitle()
Gets the title of this user.
Returns:
The title of this user.
setTitle
public void setTitle(String title)
Sets the title of this user.
Parameters:
title - The title of this user.
getDepartment
public String getDepartment()
Gets the department of this user.
Returns:
The department of this user.
setDepartment
public void setDepartment(String department)
Sets the department of this user.
Parameters:
department - The department of this user.
getFax
public String getFax()
Gets the fax information of this user.
Returns:
The fax information of this user.
setFax
public void setFax(String fax)
Sets the fax information of this user.

Parameters:
fax - The fax information of this user.
getPagerNumber
public String getPagerNumber()
Gets the pager number of this user.
Returns:
The pager number of this user.
setPagerNumber
public void setPagerNumber(String pagerNumber)
Sets the pager number of this user.
Parameters:
pagerNumber - The pager number of this user.
getNotes
public String getNotes()
Gets the notes of this user.
Returns:
The notes of this user.
setNotes
public void setNotes(String notes)
Sets the notes of this user.
Parameters:
notes - The notes of this user.
isLocked
public boolean isLocked()
Tests whether this user is locked.
Returns:
True if this user is locked.
setLocked
public void setLocked(boolean locked)
Sets whether this user is locked.

Parameters:
locked - If true, this user is locked.

Class Workday
java.lang.Object
|
+-java.lang.Enum
|
+-com.arcsight.product.core.service.v1.model.Workday
public final class Workday

extends Enum
Field Summary
public static final Friday
public static final Monday
public static final Saturday
public static final Sunday
public static final Thursday
public static final Tuesday
public static final Wednesday
Method Summary
static Workday valueOf(String name)
static Workday[] values()

compareTo
Fields
Sunday
public static final com.arcsight.product.core.service.v1.model.Workday Sunday
Monday
public static final com.arcsight.product.core.service.v1.model.Workday Monday
Tuesday
public static final com.arcsight.product.core.service.v1.model.Workday Tuesday
Wednesday
public static final com.arcsight.product.core.service.v1.model.Workday Wednesday
Thursday
public static final com.arcsight.product.core.service.v1.model.Workday Thursday
Friday
public static final com.arcsight.product.core.service.v1.model.Workday Friday
Saturday
public static final com.arcsight.product.core.service.v1.model.Workday Saturday
Methods

values
public static Workday[] values()
valueOf
public static Workday valueOf(String name)

Package
com.arcsight.product.core.service.v1.mode
l.jaxb

com.arcsight.product.core.service.v1.model.jaxb
Class HashMapOfRightListResponse
java.lang.Object
|
+-com.arcsight.coma.util.HashMapOfListsResponse
|
+-com.arcsight.product.core.service.v1.model.jaxb.HashMapOfRightListResponse
public class HashMapOfRightListResponse

extends com.arcsight.coma.util.HashMapOfListsResponse
Class to be used with JAXB for return types like HashMap>.
Constructor Summary
public HashMapOfRightListResponse()
Methods inherited from class com.arcsight.coma.util.HashMapOfListsResponse
getReturn, setReturn
Constructors
HashMapOfRightListResponse
public HashMapOfRightListResponse()

com.arcsight.product.core.service.v1.model.jaxb
Class ObjectFactory
java.lang.Object
|
+-com.arcsight.product.core.service.v1.model.jaxb.ObjectFactory
public final class ObjectFactory

extends Object
Constructor Summary
Constructors
ObjectFactory

Package
com.arcsight.product.core.service.v1.rest

com.arcsight.product.core.service.v1.rest
Class LoginServiceImpl
java.lang.Object
|
+-com.arcsight.product.core.service.v1.rest.LoginServiceImpl
public class LoginServiceImpl

extends Object
Implementation of the login service interface.
Constructor Summary
public LoginServiceImpl()
Method Summary
LoginServiceAuthentic authenticate(LoginServiceAuthenticate value)
ateResponse
Authenticates the user with the given credentials.
LoginServiceAuthentic authenticateOSPCredential(javax.ws.rs.core.HttpHeaders hh)

ateOSPCredentialRespo
nse OSP has authenticated the user, this method verifies the user is valid in the system and
processes accordingly Note: It is expected that the OSPCredential has been stashed in a
ThreadLocal variable which is known to the OSPCredential class.
LoginServiceAuthentic authenticateOSPCredential(LoginServiceAuthenticateOSPCredential value)

LoginServiceAuthentic authenticateOSPCredentialPost(javax.ws.rs.core.HttpHeaders hh)

LoginServiceGetAuthen getAuthenticationMethod(javax.ws.rs.core.HttpHeaders hh)

ticationMethodRespons
e Gets the method that applications should use to authenticate users.
LoginServiceGetAuthen getAuthenticationMethod(LoginServiceGetAuthenticationMethod value)

LoginServiceGetAuthen getAuthenticationMethodPost(javax.ws.rs.core.HttpHeaders hh)

LoginServiceGetCurren getCurrentUser(LoginServiceGetCurrentUser value)

tUserResponse
Returns the login user for the current session.
LoginServiceGetCurren getCurrentUser(String authToken, javax.ws.rs.core.HttpHeaders hh)

tUserResponse

LoginServiceGetCurren getCurrentUserPost(String authToken, javax.ws.rs.core.HttpHeaders hh)
tUserResponse
LoginServiceGetOSPSet getOSPSettings(javax.ws.rs.core.HttpHeaders hh)

tingsResponse
Gets the OSP settings from the jaas.config file.
LoginServiceGetOSPSet getOSPSettings(LoginServiceGetOSPSettings value)

tingsResponse
LoginServiceGetOSPSet getOSPSettingsPost(javax.ws.rs.core.HttpHeaders hh)

tingsResponse
LoginServiceGetServic getServiceMajorVersion(LoginServiceGetServiceMajorVersion value)

eMajorVersionResponse
The major version of this service.
LoginServiceGetServic getServiceMajorVersion(String authToken, javax.ws.rs.core.HttpHeaders hh)

eMajorVersionResponse
LoginServiceGetServic getServiceMajorVersionPost(String authToken, javax.ws.rs.core.HttpHeaders

eMajorVersionResponse hh)
LoginServiceGetServic getServiceMinorVersion(LoginServiceGetServiceMinorVersion value)

eMinorVersionResponse
The minor version of this service.
LoginServiceGetServic getServiceMinorVersion(String authToken, javax.ws.rs.core.HttpHeaders hh)

eMinorVersionResponse
LoginServiceGetServic getServiceMinorVersionPost(String authToken, javax.ws.rs.core.HttpHeaders

eMinorVersionResponse hh)
LoginServiceGetSessio getSession(LoginServiceGetSession value)

nResponse
Returns the current session.
LoginServiceGetSessio getSession(String authToken, javax.ws.rs.core.HttpHeaders hh)

nResponse
LoginServiceGetSessio getSessionPost(String authToken, javax.ws.rs.core.HttpHeaders hh)

nResponse
LoginServiceIsCASAuth isCASAuth(javax.ws.rs.core.HttpHeaders hh)

Response
Is authentication configured via CAS (Common Access Service).
LoginServiceIsCASAuth isCASAuth(LoginServiceIsCASAuth value)

Response
LoginServiceIsCASAuth isCASAuthPost(javax.ws.rs.core.HttpHeaders hh)

Response
LoginServiceLoginResp login(LoginServiceLogin value)

onse
Establishes a session using the specified login and password, and gets the string value of the
auth-token which is valid throughout the life of the session.

LoginServiceLoginResp login(String login, String password, javax.ws.rs.core.HttpHeaders hh)
onse
LoginServiceLoginForO loginForOneTimeUse(LoginServiceLoginForOneTimeUse value)

neTimeUseResponse
Establishes a session which can only be used once subsequent to its creation, and gets the
string value of auth-token which is valid throughout the life of the session.
LoginServiceLoginForO loginForOneTimeUse(String login, String password,

neTimeUseResponse javax.ws.rs.core.HttpHeaders hh)
LoginServiceLoginForO loginForOneTimeUsePost(String login, String password,

neTimeUseResponse javax.ws.rs.core.HttpHeaders hh)
LoginServiceLoginResp loginPost(String login, String password, javax.ws.rs.core.HttpHeaders hh)

onse
Void logout(LoginServiceLogout value)

Drops the current session and its bound auth-token.
Void logout(String authToken, javax.ws.rs.core.HttpHeaders hh)

Void logoutPost(String authToken, javax.ws.rs.core.HttpHeaders hh)

Void resetPassword(LoginServiceResetPassword value)

Resets the password for the user specified by the login userName.
Void resetPassword(String login, javax.ws.rs.core.HttpHeaders hh)

Void resetPasswordPost(String login, javax.ws.rs.core.HttpHeaders hh)

LoginServiceSendAuthC sendAuthChallengeResponse(int challengeId, String resp,

hallengeResponseRespo javax.ws.rs.core.HttpHeaders hh)
nse
Sends a response for the requested challenge back to JAAS CallbackHandler, which initiates
that challenge.
LoginServiceSendAuthC sendAuthChallengeResponse(LoginServiceSendAuthChallengeResponse value)

hallengeResponseRespo
nse Sends a response for the requested challenge back to JAAS CallbackHandler, which initiates
that challenge.
LoginServiceSendAuthC sendAuthChallengeResponsePost(int challengeId, String resp,

hallengeResponseRespo javax.ws.rs.core.HttpHeaders hh)
nse
Sends a response for the requested challenge back to JAAS CallbackHandler, which initiates
that challenge.

Constructors
LoginServiceImpl
public LoginServiceImpl()
Methods
login
public LoginServiceLoginResponse login(String login,
String password,
javax.ws.rs.core.HttpHeaders hh)
throws ServiceException,
AuthorizationException,
Establishes a session using the specified login and password, and gets the string value of the auth-token which is valid
throughout the life of the session.
If the provided information is enough to authenticate the user, the server sends back the authentication token. Otherwise
this method throws an ServiceException. Check the error code of the exception to determine whether authentication failed
or the server requested additional challenge if the error code equals to RuntimeLoginException.LOGIN_CHALLENGE.
The ID of the additional challenge and key for the prompt string could be retrieved from exception's message that is
prepared as String.format("prompt=%s&id=%s", challengePromptKey, Integer.toString(challengeId)).
The client application is responsible for requesting additional information from the user for the challenge ID and sending the
response back via another method sendAuthChallengeResponse.
Parameters:
login - The login user name
password - The password of the login user
authToken - Authentication token created for the current session
hh - HTTP headers from http request
Returns:
The string value of auth-token to use for further calls otherwise
Throws:
ServiceException - if authentication failed or the server challenges with additional question
com.arcsight.coma.bridge.AuthorizationException - If the user is not authorized to perform this operation
com.arcsight.coma.bridge.AuthenticationException - If the user is not authenticated
com.arcsight.tools.coma.service.ServiceException - For any errors happened during execution of this
operation
loginPost
public LoginServiceLoginResponse loginPost(String login,
String password,

Parameters:
login - The login user name
password - The password of the login user
Returns:
Throws:
login
public LoginServiceLoginResponse login(LoginServiceLogin value)
Parameters:
value - Model object containing request body
Returns:
Throws:
operation

logout
public Void logout(String authToken,
Parameters:
Throws:
operation
logoutPost
public Void logoutPost(String authToken,
Parameters:
Throws:
logout
public Void logout(LoginServiceLogout value)
Parameters:
Throws:
operation

getCurrentUser
public LoginServiceGetCurrentUserResponse getCurrentUser(String authToken,
Returns the login user for the current session. If there is no User associated with the current session this method returns
null.
Parameters:
Returns:
The login user for the current session or null
Throws:
ServiceException
operation
getCurrentUserPost
public LoginServiceGetCurrentUserResponse getCurrentUserPost(String authToken,
null.
Parameters:
Returns:
Throws:
ServiceException
getCurrentUser
public LoginServiceGetCurrentUserResponse getCurrentUser(LoginServiceGetCurrentUser
value)

null.
Parameters:
Returns:
Throws:
operation
getSession
public LoginServiceGetSessionResponse getSession(String authToken,
Parameters:
Returns:
The current session.
Throws:
ServiceException
operation
getSessionPost
public LoginServiceGetSessionResponse getSessionPost(String authToken,
Parameters:
Returns:
Throws:

ServiceException
getSession
public LoginServiceGetSessionResponse getSession(LoginServiceGetSession value)
Parameters:
Returns:
Throws:
operation
isCASAuth
public LoginServiceIsCASAuthResponse isCASAuth(javax.ws.rs.core.HttpHeaders hh)
Parameters:
Returns:
True if authentication via CAS is enabled.
Throws:
ServiceException
operation
isCASAuthPost
public LoginServiceIsCASAuthResponse isCASAuthPost(javax.ws.rs.core.HttpHeaders hh)

Parameters:
Returns:
Throws:
ServiceException
isCASAuth
public LoginServiceIsCASAuthResponse isCASAuth(LoginServiceIsCASAuth value)
Parameters:
Returns:
Throws:
operation
authenticate
public LoginServiceAuthenticateResponse authenticate(LoginServiceAuthenticate value)
Authenticates the user with the given credentials. If this is a multi-step authentication, the authContext needs to be passed
to indicate the session.
If the provided information is enough to authenticate the user, the server sends back an instance of AuthResponse
containing the authentication token. Otherwise this method throws an ServiceException. Check the error code of the
exception to determine whether authentication failed or the server requested additional challenge if the error code equals
to RuntimeLoginException.LOGIN_CHALLENGE. The ID of the additional challenge and key for the prompt string could
be retrieved from exception's message that is prepared as String.format("prompt=%s&id=%s",
challengePromptKey, Integer.toString(challengeId)). The client application is responsible for requesting
additional information from the user for the challenge ID and sending the response back via another method
sendAuthChallengeResponse.
Parameters:
Returns:
The response from the server, used to indicate if it was successful or more steps are required. Also contains the
authToken to be used in further operations

Throws:
operation
authenticateOSPCredential
public LoginServiceAuthenticateOSPCredentialResponse
authenticateOSPCredential(javax.ws.rs.core.HttpHeaders hh)
OSP has authenticated the user, this method verifies the user is valid in the system and processes accordingly Note: It is
expected that the OSPCredential has been stashed in a ThreadLocal variable which is known to the OSPCredential class.
If the provided information is enough to identify the user in the service and the user account is accessible, the server sends
back an instance of AuthResponse containing the authentication token. Otherwise this method throws an ServiceException.
Check the error code of the exception to determine what failed.
Parameters:
Returns:
Throws:
ServiceException - if authentication failed
operation
authenticateOSPCredentialPost
authenticateOSPCredentialPost(javax.ws.rs.core.HttpHeaders hh)
Parameters:
Returns:
Throws:
ServiceException - if authentication failed

authenticateOSPCredential
authenticateOSPCredential(LoginServiceAuthenticateOSPCredential value)
Parameters:
Returns:
Throws:
operation
sendAuthChallengeResponse
public LoginServiceSendAuthChallengeResponseResponse sendAuthChallengeResponse(int
challengeId,
String resp,
Sends a response for the requested challenge back to JAAS CallbackHandler, which initiates that challenge. This method is
to be called on behalf of a client (e.g. ArcSight Console) after the client receives the challenge challengeId and the user
provides the response.
If the provided response is enough to authenticate the user, the server sends back an instance of AuthResponse containing
the authentication token. Otherwise this method throws an ServiceException. Check the error code of the exception to
determine whether the server requested another challenge if the error code equals to
RuntimeLoginException.LOGIN_CHALLENGE or authentication failed. The ID of the additional challenge and key for the
prompt string could be retrieved from exception's message that is prepared as String.format("prompt=%s&id=%s",
challengePromptKey, Integer.toString(challengeId)).
Parameters:
challengeId - Identifier of a challenge send by JAAS authenticator
response - User response to the challenge
Returns:
Authentication response which includes the authentication token

Throws:
ServiceException - if authentication failed or the server challenges with another question
operation
sendAuthChallengeResponsePost
public LoginServiceSendAuthChallengeResponseResponse sendAuthChallengeResponsePost(int
challengeId,
String resp,
Parameters:
challengeId - Identifier of a challenge send by JAAS authenticator
response - User response to the challenge
Returns:
Throws:
ServiceException - if authentication failed or the server challenges with another question
sendAuthChallengeResponse
public LoginServiceSendAuthChallengeResponseResponse
sendAuthChallengeResponse(LoginServiceSendAuthChallengeResponse value)

Parameters:
Returns:
Throws:
operation
getAuthenticationMethod
public LoginServiceGetAuthenticationMethodResponse
getAuthenticationMethod(javax.ws.rs.core.HttpHeaders hh)
Gets the method that applications should use to authenticate users.
Parameters:
Returns:
The Auth
Throws:
ServiceException
operation
getAuthenticationMethodPost
getAuthenticationMethodPost(javax.ws.rs.core.HttpHeaders hh)
Parameters:
Returns:
The Auth
Throws:
ServiceException

getAuthenticationMethod
getAuthenticationMethod(LoginServiceGetAuthenticationMethod value)
Parameters:
Returns:
The Auth
Throws:
operation
loginForOneTimeUse
public LoginServiceLoginForOneTimeUseResponse loginForOneTimeUse(String login,
String password,
Establishes a session which can only be used once subsequent to its creation, and gets the string value of auth-token which
is valid throughout the life of the session.
Parameters:
login - The login user name.
Returns:
The string value of auth-token to use for further calls otherwise.
Throws:
operation

loginForOneTimeUsePost
public LoginServiceLoginForOneTimeUseResponse loginForOneTimeUsePost(String login,
String password,
Parameters:
login - The login user name.
Returns:
Throws:
loginForOneTimeUse
public LoginServiceLoginForOneTimeUseResponse
loginForOneTimeUse(LoginServiceLoginForOneTimeUse value)
Parameters:
Returns:
Throws:

operation
getOSPSettings
public LoginServiceGetOSPSettingsResponse getOSPSettings(javax.ws.rs.core.HttpHeaders hh)
Parameters:
Throws:
ServiceException
operation
getOSPSettingsPost
public LoginServiceGetOSPSettingsResponse getOSPSettingsPost(javax.ws.rs.core.HttpHeaders
hh)
Parameters:
Throws:
ServiceException
getOSPSettings
public LoginServiceGetOSPSettingsResponse getOSPSettings(LoginServiceGetOSPSettings
value)
Parameters:

Throws:
operation
resetPassword
public Void resetPassword(String login,
Resets the password for the user specified by the login userName. The ArcSight Manager assigns a new random password (8
characters, including numbers and letters) and sends it to the selected user's assigned e-mail address. Please note that this
feature needs to be configured as per ESM User's guide.
Parameters:
login - User name associated with the account.
Throws:
ServiceException
operation
resetPasswordPost
public Void resetPasswordPost(String login,
Parameters:
login - User name associated with the account.
Throws:
ServiceException

resetPassword
public Void resetPassword(LoginServiceResetPassword value)
Parameters:
Throws:
operation
getServiceMajorVersion
public LoginServiceGetServiceMajorVersionResponse getServiceMajorVersion(String
authToken,
Parameters:
Throws:
operation
getServiceMajorVersionPost
public LoginServiceGetServiceMajorVersionResponse getServiceMajorVersionPost(String
authToken,
Parameters:
Throws:

public LoginServiceGetServiceMajorVersionResponse
getServiceMajorVersion(LoginServiceGetServiceMajorVersion value)
Parameters:
Throws:
operation
getServiceMinorVersion
public LoginServiceGetServiceMinorVersionResponse getServiceMinorVersion(String
authToken,
Parameters:
Throws:
operation
getServiceMinorVersionPost
public LoginServiceGetServiceMinorVersionResponse getServiceMinorVersionPost(String
authToken,
Parameters:

Throws:
public LoginServiceGetServiceMinorVersionResponse
getServiceMinorVersion(LoginServiceGetServiceMinorVersion value)
Parameters:
Throws:
operation

Package
com.arcsight.product.core.service.v1.rest.c
onfig

com.arcsight.product.core.service.v1.rest.config
Class ApplicationConfig
java.lang.Object
|
+-javax.ws.rs.core.Application
|
+-org.glassfish.jersey.server.ResourceConfig
|
+-com.arcsight.product.core.service.v1.rest.config.ApplicationConfig
org.glassfish.jersey.server.ServerConfig, javax.ws.rs.core.Configurable
public class ApplicationConfig

extends org.glassfish.jersey.server.ResourceConfig
Nested Class Summary

class ApplicationConfig.AuthenticationExceptionMapper
ApplicationConfig.AuthenticationExceptionMapper
class ApplicationConfig.AuthorizationExceptionMapper
ApplicationConfig.AuthorizationExceptionMapper
class ApplicationConfig.JettisonJsonJaxbMessagingFeature
ApplicationConfig.JettisonJsonJaxbMessagingFeature
class ApplicationConfig.ServiceExceptionMapper
ApplicationConfig.ServiceExceptionMapper
Constructor Summary
public ApplicationConfig()
Methods inherited from class org.glassfish.jersey.server.ResourceConfig
addProperties, files, files, forApplication, forApplicationClass, forApplicationClass,

getApplication, getApplicationName, getClasses, getClassLoader, getConfiguration,
getContracts, getInstances, getProperties, getProperty, getPropertyNames, getResources,
getRuntimeType, getSingletons, isEnabled, isEnabled, isProperty, isRegistered,
isRegistered, packages, packages, property, register, register, register, register,
register, register, register, register, registerClasses, registerClasses,
registerFinder, registerInstances, registerInstances, registerResources,
registerResources, setApplicationName, setClassLoader, setProperties
Methods inherited from class javax.ws.rs.core.Application
getClasses, getProperties, getSingletons

Methods inherited from interface javax.ws.rs.core.Configurable
getConfiguration, property, register, register, register, register, register, register,

register, register
Methods inherited from interface org.glassfish.jersey.server.ServerConfig
getResources
Methods inherited from interface org.glassfish.jersey.ExtendedConfig
isProperty
Methods inherited from interface javax.ws.rs.core.Configuration
getClasses, getContracts, getInstances, getProperties, getProperty, getPropertyNames,

getRuntimeType, isEnabled, isEnabled, isRegistered, isRegistered
Constructors
ApplicationConfig
public ApplicationConfig()

Class ApplicationConfig.JettisonJsonJaxbMessagingFeature
java.lang.Object
|
+-org.glassfish.jersey.jettison.JettisonFeature
|
+-
com.arcsight.product.core.service.v1.rest.config.ApplicationConfig.JettisonJsonJaxbMessagi
ngFeature
javax.ws.rs.core.Feature
public static class ApplicationConfig.JettisonJsonJaxbMessagingFeature

extends org.glassfish.jersey.jettison.JettisonFeature
Constructor Summary
public JettisonJsonJaxbMessagingFeature()
Method Summary
boolean configure(javax.ws.rs.core.FeatureContext context)
Methods inherited from class org.glassfish.jersey.jettison.JettisonFeature
configure
Methods inherited from interface javax.ws.rs.core.Feature
configure
Constructors
JettisonJsonJaxbMessagingFeature
public JettisonJsonJaxbMessagingFeature()
Methods

configure
public boolean configure(javax.ws.rs.core.FeatureContext context)

Class ApplicationConfig.AuthenticationExceptionMapper
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.rest.config.ApplicationConfig.AuthenticationException
Mapper
javax.ws.rs.ext.ExceptionMapper
public static class ApplicationConfig.AuthenticationExceptionMapper

extends Object
implements javax.ws.rs.ext.ExceptionMapper
Constructor Summary
public AuthenticationExceptionMapper()
Method Summary
javax.ws.rs.core.Resp toResponse(AuthenticationException e)
onse
Methods inherited from interface javax.ws.rs.ext.ExceptionMapper
toResponse
Constructors
AuthenticationExceptionMapper
public AuthenticationExceptionMapper()
Methods
toResponse
public javax.ws.rs.core.Response toResponse(AuthenticationException e)

Class ApplicationConfig.AuthorizationExceptionMapper
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.rest.config.ApplicationConfig.AuthorizationExceptionM
apper
public static class ApplicationConfig.AuthorizationExceptionMapper

extends Object
Constructor Summary
public AuthorizationExceptionMapper()
Method Summary
javax.ws.rs.core.Resp toResponse(AuthorizationException e)
onse
toResponse
Constructors
AuthorizationExceptionMapper
public AuthorizationExceptionMapper()
Methods
toResponse
public javax.ws.rs.core.Response toResponse(AuthorizationException e)

Class ApplicationConfig.ServiceExceptionMapper
java.lang.Object
|
+-
com.arcsight.product.core.service.v1.rest.config.ApplicationConfig.ServiceExceptionMapper
public static class ApplicationConfig.ServiceExceptionMapper

extends Object
Constructor Summary
public ServiceExceptionMapper()
Method Summary
javax.ws.rs.core.Resp toResponse(ServiceException e)
onse
toResponse
Constructors
ServiceExceptionMapper
public ServiceExceptionMapper()
Methods
toResponse
public javax.ws.rs.core.Response toResponse(ServiceException e)

Package
com.arcsight.tools.coma.service

Class RuntimeCodedException
java.lang.Object
|
|
|
+-java.lang.RuntimeException
|
+-com.arcsight.tools.coma.service.RuntimeCodedException
Serializable

RuntimeLoginException
public class RuntimeCodedException

extends RuntimeException
Base class for various internal runtime exceptions that may happen while communicating from service layer with internal ESM
classes.
Constructor Summary
public RuntimeCodedException()
Constructs a new runtime exception with null as its detail message.
public RuntimeCodedException(String message)

Constructs a new runtime exception with the specified detail message.
public RuntimeCodedException(Throwable cause)

Constructs a new runtime exception with the specified cause and a detail message of
(cause==null ? null : cause.toString()) (which typically contains the class and detail message
of cause).
public RuntimeCodedException(String message, Throwable cause)

Constructs a new runtime exception with the specified detail message and cause.
public RuntimeCodedException(int errorCode)

Constructs a new exception with the specified error code
Method Summary
int getErrorCode()
Returns the error code associated with this exception.

Associates the error code with the exception.

Constructors
RuntimeCodedException
public RuntimeCodedException()
public RuntimeCodedException(String message)
Parameters:
message - the detail message.
public RuntimeCodedException(Throwable cause)
Constructs a new runtime exception with the specified cause and a detail message of (cause==null ? null : cause.toString())
(which typically contains the class and detail message of cause). This constructor is useful for runtime exceptions that are
little more than wrappers for other throwables.
Parameters:
cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is
permitted, and indicates that the cause is nonexistent or unknown.)
public RuntimeCodedException(String message,
Throwable cause)
Note that the detail message associated with cause is not automatically incorporated in this runtime exception's detail
message.
Parameters:
message - the detail message (which is saved for later retrieval by the Throwable.getMessage() method).

public RuntimeCodedException(int errorCode)
Parameters:
errorCode - error code identifying the exceptional case
Methods
getErrorCode
Returns the error code associated with this exception. The error code is set when the exception thrown and it indicates the
failure or irregular situation.
Returns:
the errorCode
setErrorCode
Parameters:
errorCode - The errorCode to set

Class RuntimeLoginException
java.lang.Object
|
|
|
+-java.lang.RuntimeException
|
+-com.arcsight.tools.coma.service.RuntimeCodedException
|
+-com.arcsight.tools.coma.service.RuntimeLoginException
Serializable
public class RuntimeLoginException

extends RuntimeCodedException
Exception thrown for authentication issues. It doesn't necessarily means failure. The exception could indicate a request for
additional information (challenge).
This is internal exception not returned by API calls. To report related exceptional cases to the clients API converts this exception to
ServiceLoginException
Field Summary
public static final LOGIN_CHALLENGE
Indicates additional challenge requested by the server.
Value: -4
public static final LOGIN_ERROR_FAILURE

Indicates login failure.
Value: 0
public static final LOGIN_ERROR_LICENSE_EXPIRED

Indicates an expired license.
Value: -1
public static final LOGIN_ERROR_PASSWORD_EXPIRED

Indicates expired password.
Value: -3
public static final LOGIN_ERROR_USER_DISABLED

Indicates the fact that user account was disabled.
Value: -2
public static final LOGIN_ERROR_USER_NOT_ALLOWED

Indicates that the user doesn't have permission to access the component.
Value: -5

Constructor Summary
public RuntimeLoginException()
public RuntimeLoginException(String message)

public RuntimeLoginException(Throwable cause)

Constructs a new runtime exception with the specified cause and a detail message of
(cause==null ? null : cause.toString()) (which typically contains the class and detail message
of cause).
public RuntimeLoginException(String message, Throwable cause)

public RuntimeLoginException(int errorCode)
Methods inherited from class com.arcsight.tools.coma.service.RuntimeCodedException
getErrorCode, setErrorCode

Fields
LOGIN_ERROR_FAILURE
public static final int LOGIN_ERROR_FAILURE

Constant value: 0
LOGIN_ERROR_LICENSE_EXPIRED
public static final int LOGIN_ERROR_LICENSE_EXPIRED

Constant value: -1
LOGIN_ERROR_USER_DISABLED
public static final int LOGIN_ERROR_USER_DISABLED

Constant value: -2
LOGIN_ERROR_PASSWORD_EXPIRED
public static final int LOGIN_ERROR_PASSWORD_EXPIRED
Indicates expired password.

Constant value: -3
LOGIN_CHALLENGE
public static final int LOGIN_CHALLENGE
Indicates additional challenge requested by the server. Login cannot be completed until the user to meet the challenge.
Constant value: -4
LOGIN_ERROR_USER_NOT_ALLOWED
public static final int LOGIN_ERROR_USER_NOT_ALLOWED
Constant value: -5
Constructors
public RuntimeLoginException()
public RuntimeLoginException(String message)
Parameters:
message - the detail message.
public RuntimeLoginException(Throwable cause)
Constructs a new runtime exception with the specified cause and a detail message of (cause==null ? null : cause.toString())
(which typically contains the class and detail message of cause). This constructor is useful for runtime exceptions that are
little more than wrappers for other throwables.
Parameters:

public RuntimeLoginException(String message,
Throwable cause)
Note that the detail message associated with cause is not automatically incorporated in this runtime exception's detail
message.
Parameters:
public RuntimeLoginException(int errorCode)

Interface Service
All Known Implementing Classes:
ServiceBase
public interface Service

extends
Base interface for services.
Method Summary
abstract int getServiceMajorVersion()
abstract int getServiceMinorVersion()

Methods
public abstract int getServiceMajorVersion()
Returns:
public abstract int getServiceMinorVersion()
Returns:

Class ServiceBase
java.lang.Object
|
+-com.arcsight.tools.coma.service.ServiceBase
Service
public abstract class ServiceBase

extends Object
implements Service
Base service implementation.
Constructor Summary
public ServiceBase()
Method Summary
int getServiceMajorVersion()
int getServiceMinorVersion()
Methods inherited from interface com.arcsight.tools.coma.service.Service
getServiceMajorVersion, getServiceMinorVersion
Constructors
ServiceBase
public ServiceBase()
Methods

public int getServiceMajorVersion()
public int getServiceMinorVersion()

Class ServiceException
java.lang.Object
|
|
|
+-com.arcsight.tools.coma.service.ServiceException

ValidationException, ServiceLoginException
public class ServiceException

extends Exception
implements Serializable, Serializable
This is exception for kahuna/coma service. There are several reasons to have special exception impl: 1. Make it serializable so all
service binding can marshal it 2. Due to the known GWT marshaling issue, parent message can not be marshaled we have to
duplicated parent instance variables in this class.
Field Summary
public static final ERROR_UNKNOWN
Value: -54188
Constructor Summary
public ServiceException()
Constructs a new exception with null as its detail message.
public ServiceException(String message)

Constructs a new exception with the specified detail message.
public ServiceException(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ?
null : cause.toString()) (which typically contains the class and detail message of cause).
public ServiceException(String message, Throwable cause)

Constructs a new exception with the specified detail message and cause.
Method Summary
static String buildExceptionStackTraceString(Throwable e)
It builds a string for stack trace of an exception.

static createServiceException(Throwable e)
ServiceException
It creates an exception which is serializable.
int getErrorCode()
Returns the error code associated with this exception.


Fields
ERROR_UNKNOWN
public static final int ERROR_UNKNOWN
Constant value: -54188
Constructors
ServiceException
public ServiceException()
Constructs a new exception with null as its detail message. The cause is not initialized, and may subsequently be initialized
by a call to Throwable.initCause(java.lang.Throwable).
ServiceException
public ServiceException(String message)
Constructs a new exception with the specified detail message. The cause is not initialized, and may subsequently be
initialized by a call to Throwable.initCause(java.lang.Throwable).
Parameters:
message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage()
method.
ServiceException
public ServiceException(Throwable cause)

Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which
typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than
wrappers for other throwables (for example, java.security.PrivilegedActionException).
Parameters:
ServiceException
public ServiceException(String message,
Throwable cause)
Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.
Parameters:
Methods
buildExceptionStackTraceString
public static String buildExceptionStackTraceString(Throwable e)
It builds a string for stack trace of an exception. It is used for debugging log.
Parameters:
e
Returns:
createServiceException
public static ServiceException createServiceException(Throwable e)
It creates an exception which is serializable. Some of the throwables, such as NullPointerException, are not serializable.
They will cause serialization error when they are wrapped in service exception. This approach wraps all stack traces as string
in service exception.
Parameters:
e
Returns:
getErrorCode
Returns the error code associated with this exception. The error code is set when the exception thrown and it indicates the
failure or irregular situation.

Returns:
the errorCode
setErrorCode
Parameters:
errorCode - The errorCode to set

Class ServiceLoginException
java.lang.Object
|
|
|
|
+-com.arcsight.tools.coma.service.ServiceLoginException
public class ServiceLoginException

extends ServiceException
Exception thrown for authentication issues. It doesn't necessarily means failure. The exception could indicate a request for
additional information (challenge).
Field Summary
public static final LOGIN_ERROR_FAILURE
Value: 0
public static final LOGIN_ERROR_LICENSE_EXPIRED

Value: -1
public static final LOGIN_ERROR_USER_DISABLED

Value: -2
public static final LOGIN_ERROR_USER_NOT_ALLOWED

Value: -5
Fields inherited from class com.arcsight.tools.coma.service.ServiceException
ERROR_UNKNOWN
Constructor Summary
public ServiceLoginException()
public ServiceLoginException(String message)


public ServiceLoginException(Throwable cause)
Constructs a new exception with the specified cause and a detail message of (cause==null ?
null : cause.toString()) (which typically contains the class and detail message of cause).
public ServiceLoginException(String message, Throwable cause)

public ServiceLoginException(int errorCode)

Methods inherited from class com.arcsight.tools.coma.service.ServiceException
buildExceptionStackTraceString, createServiceException, getErrorCode, setErrorCode

Fields
LOGIN_ERROR_FAILURE
public static final int LOGIN_ERROR_FAILURE

Constant value: 0
LOGIN_ERROR_LICENSE_EXPIRED
public static final int LOGIN_ERROR_LICENSE_EXPIRED

Constant value: -1
LOGIN_ERROR_USER_DISABLED
public static final int LOGIN_ERROR_USER_DISABLED

Constant value: -2
LOGIN_ERROR_USER_NOT_ALLOWED
public static final int LOGIN_ERROR_USER_NOT_ALLOWED

Constant value: -5
Constructors
public ServiceLoginException()
public ServiceLoginException(String message)
Parameters:
message - the detail message. The detail message is saved for later retrieval by the Throwable.getMessage()
method.
public ServiceLoginException(Throwable cause)
Constructs a new exception with the specified cause and a detail message of (cause==null ? null : cause.toString()) (which
typically contains the class and detail message of cause). This constructor is useful for exceptions that are little more than
wrappers for other throwables (for example, java.security.PrivilegedActionException).
Parameters:
public ServiceLoginException(String message,
Throwable cause)
Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.
Parameters:
public ServiceLoginException(int errorCode)
Parameters:
errorCode - error code identifying the exceptional case

Class ValidationException
java.lang.Object
|
|
|
|
+-com.arcsight.tools.coma.service.ValidationException
public class ValidationException

extends ServiceException
Base class for various validation exceptions to indicate failures to validate different types of data (e.g. password).
Fields inherited from class com.arcsight.tools.coma.service.ServiceException
ERROR_UNKNOWN
Constructor Summary
public ValidationException()
public ValidationException(String message)

public ValidationException(String message, Map validationErrors)

Constructs a new exception with the specified detail message and a map containing error
descriptions.
Method Summary
String getLocalizedMessage()
String getMessage()
Map getValidationErrors()
Returns validationErrors, which is a map of errors found for different items.
void setValidationErrors(Map validationErrors)

Sets the validationErrors.
String toString()

Methods inherited from class com.arcsight.tools.coma.service.ServiceException
buildExceptionStackTraceString, createServiceException, getErrorCode, setErrorCode

Constructors
ValidationException
public ValidationException()
ValidationException
public ValidationException(String message)
Parameters:
message - the detail message. The detail message is saved for later retrieval by the getMessage() method.
ValidationException
public ValidationException(String message,
Map validationErrors)
Constructs a new exception with the specified detail message and a map containing error descriptions. The cause is not
initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).
Parameters:
message - the detail message. The detail message is saved for later retrieval by the getMessage() method.
validationErrors - Map containing errors found for different items
Methods
getValidationErrors
public Map getValidationErrors()
Returns validationErrors, which is a map of errors found for different items.

Returns:
the validationErrors errors associated with different properties
setValidationErrors
public void setValidationErrors(Map validationErrors)
Sets the validationErrors.
Parameters:
validationErrors - the validationErrors to set
getMessage
getLocalizedMessage
public String getLocalizedMessage()
toString
public String toString()

API Reference V1 CoreClientServices

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

API Reference V1 CoreClientServices

Uploaded by

Copyright:

Available Formats

Micro Focus Security

ArcSight ESM Service Layer

API Reference Vol. 1: Core-Client Services

Document Release Date: December 2021

Support Web Site https://softwaresupport.softwaregrp.com/

ArcSight Product Documentation https://community.softwaregrp.com/t5/ArcSight-Product-Documentation/ct-p/productdocs

Micro Focus ESM Service Layer 7.6 Page 2 of 2

ESM Service Layer: Core Services 2.0 Page 3

public class AuthenticationException

public AuthenticationException(String service, String method)

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage,

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

ESM Service Layer: Core Services 2.0 Page 4

public class AuthorizationException

public AuthorizationException(String service, String method, boolean

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage,

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

(continued on next page)

ESM Service Layer: Core Services 2.0 Page 5

ESM Service Layer: Core Services 2.0 Page 6

ESM Service Layer: Core Services 2.0 Page 7

public class RemoteServiceException

public RemoteServiceException(String message, Throwable cause)

public RemoteServiceException(String message)

public RemoteServiceException(Throwable cause)

void setErrorCode(int errorCode)

void setRemoteStacktrace(String remoteStacktrace)

Methods inherited from class java.lang.Throwable

ESM Service Layer: Core Services 2.0 Page 8

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constant value: -54188

ESM Service Layer: Core Services 2.0 Page 9

ESM Service Layer: Core Services 2.0 Page 10

ESM Service Layer: Core Services 2.0 Page 11

public class AuthenticationExceptionBean

void setMessage(String message)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

ESM Service Layer: Core Services 2.0 Page 12

ESM Service Layer: Core Services 2.0 Page 13

public class AuthorizationExceptionBean

void setMessage(String message)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

ESM Service Layer: Core Services 2.0 Page 14

ESM Service Layer: Core Services 2.0 Page 15

public class GetAllRightsByGroupTypeResponse

void setReturn(HashMap _return)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

ESM Service Layer: Core Services 2.0 Page 16

ESM Service Layer: Core Services 2.0 Page 17

public class LoginServiceAuthenticate

void setAuthContext(AuthContext authContext)

void setAuthToken(String authToken)

void setCred(PasswordCredential cred)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait