public class AdministrationServiceClient
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
protected java.lang.String |
clientReferenceId |
protected java.lang.Integer |
ErrorCode |
protected boolean |
internal |
static boolean |
logging |
protected java.lang.String[] |
messages |
protected boolean |
secure |
protected java.lang.String |
sessionId |
| Constructor and Description |
|---|
AdministrationServiceClient()
Creates a non-webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String serviceURL,
boolean secure,
boolean internal)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
boolean secure)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL,
boolean secure,
boolean internal)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL,
boolean secure,
boolean internal,
boolean test)
Creates a webservices session-based connection to Yellowfin.
|
AdministrationServiceClient(java.lang.String username,
java.lang.String password)
Creates a non-webservices session-based connection to Yellowfin.
|
| Modifier and Type | Method and Description |
|---|---|
boolean |
addBirtReport(AdministrationReport birtReport)
Upload a BIRT report into Yellowfin.
|
boolean |
addColumnToViews(java.lang.Integer sourceId,
java.lang.String tableName,
java.lang.String columnName,
java.lang.String fieldCategoryName)
Adds a column on a specific table to all views that use that table.
|
boolean |
addColumnToViews(java.lang.String dataSourceName,
java.lang.String tableName,
java.lang.String columnName,
java.lang.String fieldCategoryName)
Adds a column on a specific table to all views that use that table.
|
boolean |
addPersonFavourite(PersonFavourite pf) |
boolean |
addToFavourites(AdministrationReport report,
AdministrationPerson person) |
boolean |
addToFavourites(java.lang.Integer reportId,
java.lang.String loginId) |
boolean |
addToUserFavourites(AdministrationPerson person,
AdministrationReport report)
Assign a report to a users favourites list
|
boolean |
addUserAccess(AdministrationPerson person,
AdministrationClientOrg client)
Allows a user to log in to a client organisation.
|
boolean |
addUserToGroup(AdministrationPerson person,
AdministrationGroup group,
boolean include)
Adds a user to a group.
|
boolean |
approveReport(java.lang.Integer reportId) |
boolean |
changePassword(java.lang.String userId,
java.lang.String newPassword)
Change a user's password.
|
boolean |
closeConnectionPool(java.lang.Integer sourceId) |
boolean |
createClient(AdministrationClientOrg client)
Creates a client organisation.
|
boolean |
createGroup(AdministrationGroup group)
Create a new group.
|
AdministrationPerson |
createUniqueUser(AdministrationPerson person)
Create a new unique user.
|
boolean |
createUser(AdministrationPerson person)
Create a new user.
|
boolean |
deleteClient(AdministrationClientOrg client)
Deletes a client organisation.
|
boolean |
deleteFavourite(AdministrationReport report,
AdministrationPerson person) |
boolean |
deleteFavourite(java.lang.Integer reportId,
java.lang.String loginId) |
boolean |
deleteGroup(AdministrationGroup group)
Delete a group.
|
void |
deleteSchedule(java.lang.String scheduleUUID) |
boolean |
deleteUser(AdministrationPerson person)
Delete the specified user
|
boolean |
delGeopack(java.lang.String packId)
Force Yellowfin to remove a particular GeoPack from the geopack cache.
|
protected AdministrationServiceResponse |
doWebServicesRequest(AdministrationServiceRequest rsr)
Perform a Webservices Request (Used Internally and by methods in i4Report)
|
boolean |
editUser(AdministrationPerson person)
Update details for a user.
|
boolean |
flushBinaryClassLoaderCache()
Force Yellowfin to refresh the binary class loader cache for a particular view
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
flushCachedFilterCache(java.lang.Integer filterId) |
boolean |
flushGeometry(java.lang.Integer ViewId)
Force Yellowfin to refresh the geometry cache for a particular view
Used by Yellowfin to synchronise with cluster nodes
|
AdministrationClientOrg |
getClient(AdministrationClientOrg client)
Retrieve a client organisation from the server.
|
static java.lang.String |
getClientBuild()
Returns the build version number that the client library was built against
(eg.
|
java.lang.String |
getClientReferenceId()
Returns the client reference id used in web service calls.
|
static java.lang.String |
getClientRelease()
Returns the major release version that the client library was built against
(eg.
|
java.lang.Integer |
getErrorCode()
Returns the error code from the most recent service call.
|
AdministrationGroup |
getGroup(AdministrationGroup group)
Fetch a group record from the server.
|
java.lang.String[] |
getMessages()
Get Messages from last service call.
|
int |
getPort()
Returns the tcp port to connect to
|
AdministrationReport |
getReportForUser(AdministrationPerson person,
java.lang.Integer reportId)
Get a specified report for the given user.
|
AdministrationServiceResponse |
getRs() |
AdministrationServiceRequest |
getRsr() |
java.lang.String |
getServiceURL()
Returns the alternate service path
|
java.lang.String |
getSessionId() |
AdministrationPerson |
getUser(java.lang.String UserId)
Fetch the user with the given UserId from the server
|
AdministrationPerson[] |
getUserAccess(AdministrationClientOrg client)
Retrieves the users that can log into a client organisation.
|
AdministrationClientOrg[] |
getUserAccess(AdministrationPerson person)
Retrieves the clients that a user can log in to.
|
AdministrationPerson |
getUserByIp(java.lang.Integer IpId)
Fetch the user with the given IpId from the server
|
java.lang.String |
getUsername()
Returns the username of the Yellowfin user to connect to the web service
|
AdministrationPerson[] |
getUsersFromSearch(java.lang.String searchString,
java.lang.Integer IpId)
Fetch the user with the given UserId from the server
|
java.lang.String |
getWebServicesHost()
Returns the host to connect to
|
boolean |
isReportFavourite(AdministrationReport report,
AdministrationPerson person) |
boolean |
isReportFavourite(java.lang.Integer reportId,
java.lang.String loginId) |
ParentDashboard[] |
listAllParentTabs(AdministrationPerson person,
boolean loadReports)
List all dashboard tabs for the given user
|
AdministrationReport[] |
listAllReportsForUser(AdministrationPerson person)
List all reports for the given user, regardless of whether they are web-service enabled.
|
AdministrationReport[] |
listAllReportsFromRegex(java.lang.String regex,
AdministrationPerson p)
List all reports that contain a string regex
|
AdministrationReport[] |
listAllReportsWithComments(AdministrationPerson person)
List all reports for the given user, regardless of whether they are web-service enabled.
|
AdministrationSchedule[] |
listAllSchedules() |
AdministrationReportGroup[] |
listAllTabsForUser(AdministrationPerson person)
List all dashboard tabs for the given user
|
AdministrationReportGroup[] |
listAllTabsForUser(AdministrationPerson person,
boolean loadReports)
List all dashboard tabs for the given user
|
AdministrationReportGroup[] |
listAllTabsForUser(AdministrationPerson person,
boolean loadReports,
java.lang.Integer tabId)
List all dashboard tabs for the given user
|
ParentDashboard |
listAllTabsForUserFromParent(AdministrationPerson person,
boolean loadReports,
java.lang.Integer tabId)
List all dashboard subtabs for the given Dashboard id
|
AdministrationClientOrg[] |
listClients()
Retrieve a list of client organisations from the server.
|
AdministrationGroup[] |
listGroups()
Retrieve a list of groups from the server.
|
ParentReportGroup[] |
listParentsTabsWithSubTabsForUser(AdministrationPerson person,
boolean loadReports,
java.lang.Integer tabId) |
PersonFavourite[] |
listPersonFavourites(PersonFavourite pf) |
PersonFavourite[] |
listPersonFavourites(PersonFavourite pf,
java.lang.Integer retrospectiveDays) |
AdministrationReport[] |
listReportsForUser(AdministrationPerson person)
List all webservice enabled reports for the given user.
|
AdministrationRole[] |
listRoles()
Retrieve a list of roles from the server.
|
AdministrationReport[] |
listUserFavourites(AdministrationPerson person)
List all favourites for the given user
|
AdministrationReport[] |
listUserInbox(AdministrationPerson person)
List all inbox reports for the given user
|
AdministrationSchedule |
loadSchedule(java.lang.String scheduleUUID) |
java.lang.String |
loginUser(AdministrationPerson person)
Authenticate a user and return a session token used to log in.
|
java.lang.String |
loginUser(AdministrationPerson person,
java.lang.String[] loginParameters)
Authenticate a user and return a session token used to log in.
|
java.lang.String |
loginUserUnsecure(AdministrationPerson person,
java.lang.String[] loginParameters)
Authenticate a user and return a session token used to log in.
|
boolean |
logoutUser(AdministrationPerson person)
Destory a users session.
|
boolean |
logoutUser(AdministrationPerson person,
java.lang.String SessionId) |
boolean |
logoutUser(java.lang.String SessionId)
Destory a users session.
|
boolean |
logoutUserByUserIp(java.lang.Integer UserIp,
java.lang.String ContainerSessionId) |
boolean |
logoutUserByUserIpWithErrorsSuppressed(java.lang.Integer userIp,
java.lang.String containerSessionId)
Logout User by Internal Id, with error suppression
|
boolean |
logoutUserByUserName(java.lang.String UserName) |
boolean |
logoutUserByUserName(java.lang.String UserName,
java.lang.String ContainerSessionId) |
boolean |
logoutUserByUserNameWithErrorsSuppressed(java.lang.String userName,
java.lang.String containerSessionId)
Logout User by username, with error suppression
|
boolean |
logoutUserWithUserName(java.lang.String Username)
Destory a users session.
|
boolean |
modifyGroup(AdministrationGroup group)
Modify a group.
|
AdministrationSchedule |
pauseSchedule(java.lang.String scheduleUUID) |
boolean |
performCacheCommands(AdministrationCacheCommand[] commands)
Send a request to run a set of commands against system caches.
|
void |
refreshAccessLevelList(java.lang.Integer contentId) |
boolean |
rejectReport(java.lang.Integer reportId) |
boolean |
reloadCodes(java.util.ArrayList<java.lang.String> codes)
Force Yellowfin to reload reference codes
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
reloadLicence() |
void |
removeAccessLevelFromCache(java.lang.String contentKey) |
boolean |
removeContentManagementFromCache(java.lang.Integer contentId)
Force removal of a view from the view cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeDashboardFromCache(java.lang.Integer tabId)
Force removal of a tab from the dashboard definition cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeDocumentFromCache(java.lang.Integer documentId)
Force removal of a view from the view cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeFromRESTUserCache(RESTUserCacheRemovalInfo removalInfo)
Remove entries from the RESTUserCache
|
boolean |
removeGroupFromCache(java.lang.Integer groupId)
Force removal of a group from the group cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removePersonFavourite(PersonFavourite pf) |
boolean |
removePersonFromCache(java.lang.Integer personId)
Force removal of a person from the person cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeReportFromCache(java.lang.Integer ReportId)
Force removal of a report from the report definition cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeTextEntityFromCache(java.lang.Integer textId)
Force removal of a text entity from the text entity cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
removeUserAccess(AdministrationPerson person,
AdministrationClientOrg client)
Disallows a user to log in to a client organisation.
|
boolean |
removeUserFromGroup(AdministrationPerson person,
AdministrationGroup group)
Removes a user from a group.
|
boolean |
removeViewFromCache(java.lang.Integer ViewId)
Force removal of a view from the view cache
Used by Yellowfin to synchronise with cluster nodes
|
boolean |
requestPasswordReset(java.lang.String userId)
Request a password reset for the given userid.
|
AdministrationSchedule |
resumeSchedule(java.lang.String scheduleUUID) |
ReportBinaryObject |
retrieveAvatar(java.lang.Integer id) |
ReportBinaryObject |
retrieveAvatar(java.lang.String id) |
ReportBinaryObject[] |
retrieveAvatars(java.lang.Integer[] ids) |
ReportBinaryObject[] |
retrieveAvatars(java.lang.String[] ids) |
AdministrationSchedule |
runScheduleNow(java.lang.String scheduleUUID) |
AdministrationSchedule |
saveSchedule(AdministrationSchedule schedule) |
byte[] |
serialize(java.io.Serializable obj)
Convert an object into a byte array.
|
boolean |
setAvatarImage(AdministrationPerson person,
java.lang.String base64EncodedImage)
Sets the a uses avatar image
|
void |
setClientReferenceId(java.lang.String clientReferenceId)
Sets the client reference id used in web service calls.
|
void |
setErrorCode(java.lang.Integer errorCode) |
void |
setRs(AdministrationServiceResponse rs) |
void |
setRsr(AdministrationServiceRequest rsr) |
int |
testConnection()
Tests the webservices connection.
|
boolean |
updateAdminMode(java.util.Map<java.lang.String,java.lang.String> functions,
boolean enableAdminMode)
Send a request to enable/disable admin mode based on the enableAdminMode boolean.
|
boolean |
updateClient(AdministrationClientOrg client)
Updates a client organisation.
|
boolean |
validatePassword(java.lang.String userId,
java.lang.String password)
Authenticate a user without logging them in.
|
boolean |
validateUser(java.lang.String userId,
java.lang.String password)
Authenticate a user without logging them in.
|
boolean |
validateUserAllOrgs(java.lang.String userId,
java.lang.String password)
Authenticate a user without logging them in but do not enfore client org
This is the preferred method to check if a supplied userid/password
is valid.
|
public static final boolean logging
protected java.lang.String sessionId
protected java.lang.String[] messages
protected boolean secure
protected boolean internal
protected java.lang.Integer ErrorCode
protected java.lang.String clientReferenceId
public AdministrationServiceClient()
throws WebserviceException
WebserviceExceptionpublic AdministrationServiceClient(java.lang.String username,
java.lang.String password)
throws WebserviceException
username - Web Service UserNamepassword - Web Service User PasswordWebserviceExceptionpublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service Portusername - Web Service UserNamepassword - Web Service User PasswordWebserviceExceptionpublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
boolean secure)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service Portusername - Web Service UserNamepassword - Web Service User Passwordsecure - Whether or not to make an SSL connectionWebserviceExceptionpublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service Portusername - Web Service UserNamepassword - Web Service User PasswordserviceURL - Alternate Web Service pathWebserviceExceptionpublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL,
boolean secure,
boolean internal)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service Portusername - Web Service UserNamepassword - Web Service User PasswordserviceURL - Alternate Web Service pathsecure - Whether or not to make an SSL connection?internal - connect to Yellowfin within this JVM (not using web services)WebserviceException - if an error occurred connecting to the web servicepublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String username,
java.lang.String password,
java.lang.String serviceURL,
boolean secure,
boolean internal,
boolean test)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service Portusername - Web Service UserNamepassword - Web Service User PasswordserviceURL - Alternate Web Service pathsecure - Whether or not to make an SSL connection?internal - connect to Yellowfin within this JVM (not using web services)WebserviceException - if an error occurred connecting to the web servicepublic AdministrationServiceClient(java.lang.String webServiceHost,
int webServicePort,
java.lang.String serviceURL,
boolean secure,
boolean internal)
throws WebserviceException
webServiceHost - Web Service HostwebServicePort - Web Service PortserviceURL - Alternate Web Service pathsecure - Whether or not to make an SSL connection?internal - connect to Yellowfin within this JVM (not using web services)WebserviceException - if an error occurred connecting to the web servicepublic boolean createUser(AdministrationPerson person)
person - the AdministrationPerson objectpublic AdministrationPerson createUniqueUser(AdministrationPerson person)
person - the AdministrationPerson objectpublic boolean editUser(AdministrationPerson person)
person - the AdministrationPerson objectpublic boolean changePassword(java.lang.String userId,
java.lang.String newPassword)
userId - the User Id of the user to changenewPassword - the new password for the userpublic AdministrationPerson getUser(java.lang.String UserId)
UserId - the user idpublic AdministrationPerson getUserByIp(java.lang.Integer IpId)
UserId - the user idpublic AdministrationPerson[] getUsersFromSearch(java.lang.String searchString, java.lang.Integer IpId)
UserId - the user idpublic boolean deleteUser(AdministrationPerson person)
person - the user to deletepublic java.lang.String loginUser(AdministrationPerson person)
client reference id is set,
the user will be authenticated against that client.person - the user to login. The userId and password fields must be set.loginUser(AdministrationPerson, String[])public boolean logoutUser(AdministrationPerson person)
person - the user to logout. Yellowfin will destory all sessions for this user#logoutUser(AdministrationPerson, String[])public boolean logoutUserWithUserName(java.lang.String Username)
username - of the user to logout. Yellowfin will destory all sessions for this user#logoutUser(AdministrationPerson, String[])public boolean logoutUser(java.lang.String SessionId)
SessionID - this is the SessionId obtained from a web-service login. This will destroy the single session matching this id.logoutUser(AdministrationPerson, String)public boolean validateUser(java.lang.String userId,
java.lang.String password)
client reference id is set,
the user will be authenticated against that client.userId - the userIdpassword - the passwordpublic boolean validateUserAllOrgs(java.lang.String userId,
java.lang.String password)
userId - the userIdpassword - the passwordpublic boolean validatePassword(java.lang.String userId,
java.lang.String password)
client reference id is set,
the user will be authenticated against that client.userId - the userIdpassword - the passwordpublic boolean requestPasswordReset(java.lang.String userId)
userId - the user id to request the password reset forpublic java.lang.String loginUser(AdministrationPerson person, java.lang.String[] loginParameters)
Authenticate a user and return a session token used to log in.
If the client reference id is set,
the user will be authenticated against that client.
Parameters may be passed to the login process to modify the user's session. Parameters take the form "key=value", and the following are valid parameters:
| Key | Values | Description |
| yftoolbar | true/false | Whether or not to show the toolbar (Dashboard, Create Report, Report List and Administration links) on appropriate pages. Setting this option overrides the system-wide configuration setting. |
| entry | dashboard reportlist createreport administration viewreport |
The initial page to redirect to upon login. The user must have the necessary functional access. The default is dashboard if the user has dashboard access, otherwise reportlist. If set to viewreport, you must also set the reportid or reportname. |
| reportid | ReportId | When entry=viewreport, this specifies the report to view. |
| reportname | Report Object Name | When entry=viewreport, this specifies the report to view. |
| filter<FilterId> | Filter Value | When entry=viewreport, this sets the value for a prompt filter in the report. Multiple filter values may be set, using the FilterId for each one. The Filter Ids can be retrieved from the ReportService. |
| disablesourcefilters | true/false | If this is set to true, source filters will be disabled on all reports run by this user during the login session. Only enable this for users who are allowed to see all data unrestricted. Note: this does not affect reports created against Stored Procedures that use a source filter for one of the parameters to the Stored Procedure. |
| hideheader | true/false | If this is set to true, the page header will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidefooter | true/false | If this is set to true, the page footer will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidesidenav | true/false | If this is set to true, the page left navigation will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidelogoff | true/false | If this is set to true, the logoff links will not be shown. |
| reasoncode | reason | A reason code to include in events logged during this user's session |
| reasondescription | reason | A reason description to include in events logged during this user's session |
For example:
AdministrationPerson ap = asc.getUser("admin");
ap.setPassword("password");
String[] parameters = {
"entry=administration",
"disablesourcefilters=true"
};
String token = asc.loginUser(ap, parameters);
person - the user to login. The userId and password fields must be set.loginParameters - parameters to pass to the login processpublic java.lang.String loginUserUnsecure(AdministrationPerson person, java.lang.String[] loginParameters)
Authenticate a user and return a session token used to log in.
If the client reference id is set,
the user will be authenticated against that client.
Parameters may be passed to the login process to modify the user's session. Parameters take the form "key=value", and the following are valid parameters:
| Key | Values | Description |
| yftoolbar | true/false | Whether or not to show the toolbar (Dashboard, Create Report, Report List and Administration links) on appropriate pages. Setting this option overrides the system-wide configuration setting. |
| entry | dashboard reportlist createreport administration viewreport |
The initial page to redirect to upon login. The user must have the necessary functional access. The default is dashboard if the user has dashboard access, otherwise reportlist. If set to viewreport, you must also set the reportid or reportname. |
| reportid | ReportId | When entry=viewreport, this specifies the report to view. |
| reportname | Report Object Name | When entry=viewreport, this specifies the report to view. |
| disablesourcefilters | true/false | If this is set to true, source filters will be disabled on all reports run by this user during the login session. Only enable this for users who are allowed to see all data unrestricted. Note: this does not affect reports created against Stored Procedures that use a source filter for one of the parameters to the Stored Procedure. |
| hideheader | true/false | If this is set to true, the page header will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidefooter | true/false | If this is set to true, the page footer will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidesidenav | true/false | If this is set to true, the page left navigation will not be shown. Setting this option overrides the system-wide configuration setting. |
| hidelogoff | true/false | If this is set to true, the logoff links will not be shown. |
| reasoncode | reason | A reason code to include in events logged during this user's session |
| reasondescription | reason | A reason description to include in events logged during this user's session |
For example:
AdministrationPerson ap = asc.getUser("admin");
String[] parameters = {
"entry=administration",
"disablesourcefilters=true"
};
String token = asc.loginUser(ap, parameters);
person - the user to login. The userId fields must be set.loginParameters - parameters to pass to the login processpublic boolean logoutUser(AdministrationPerson person, java.lang.String SessionId)
public AdministrationReport[] listReportsForUser(AdministrationPerson person)
client reference id is set,
reports for that client will be returned.person - the person to list reports forpublic AdministrationReport[] listAllReportsForUser(AdministrationPerson person)
client reference id is set,
reports for that client will be returned.person - the person to list reports forpublic AdministrationReport getReportForUser(AdministrationPerson person, java.lang.Integer reportId)
client reference id is set,
reports for that client will be returned.person - the person to list reports forreportId - the report id to getpublic AdministrationReport[] listAllReportsWithComments(AdministrationPerson person)
client reference id is set,
reports for that client will be returned.person - the person to list reports forpublic AdministrationReport[] listAllReportsFromRegex(java.lang.String regex, AdministrationPerson p)
person - the person to list reports for, regex the string to searchpublic AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person)
the - person to list reports forpublic AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person, boolean loadReports)
the - person to list reports forloadreports - will load a list of reports present on the tab.public AdministrationReportGroup[] listAllTabsForUser(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)
the - person to list reports forloadreports - will load a list of reports present on the tab.tabId - Tab id to load (null for all)public ParentReportGroup[] listParentsTabsWithSubTabsForUser(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)
public ParentDashboard[] listAllParentTabs(AdministrationPerson person, boolean loadReports)
the - person to list reports forloadreports - will load a list of reports present on the tab.tabId - Tab id to load (null for all)public ParentDashboard listAllTabsForUserFromParent(AdministrationPerson person, boolean loadReports, java.lang.Integer tabId)
the - person to list reports forloadreports - will load a list of reports present on the tab.tabId - dashboard IDpublic AdministrationReport[] listUserFavourites(AdministrationPerson person)
person - the person to list reports forloadreports - will load a list of reports present in the favourites listpublic boolean addToUserFavourites(AdministrationPerson person, AdministrationReport report)
person, - the person to list reports forreport, - the report to addpublic AdministrationReport[] listUserInbox(AdministrationPerson person)
person - the person to list reports forloadreports - will load a list of reports present in the users inboxpublic boolean createGroup(AdministrationGroup group)
client reference id is set,
the group will be created under that client.group - the AdministrationGroup to createpublic AdministrationGroup getGroup(AdministrationGroup group)
client reference id is set,
only a group for that client will be returned.group - an AdministrationGroup object. The GroupName must be set.public boolean deleteGroup(AdministrationGroup group)
client reference id is set,
the group must belong to that client.group - the AdministrationGroup object you want to deletepublic boolean modifyGroup(AdministrationGroup group)
client reference id is set,
the group must belong to that client.group - the AdministrationGroup object you want to modifypublic AdministrationGroup[] listGroups()
client reference id is set,
groups for that client will be returned.public AdministrationRole[] listRoles()
public boolean addUserToGroup(AdministrationPerson person, AdministrationGroup group, boolean include)
client reference id to indicate a group at
a particular client organisation.person - the person to add to the groupgroup - the groupinclude - whether to include or exclude the user from the grouppublic boolean removeUserFromGroup(AdministrationPerson person, AdministrationGroup group)
client reference id to indicate a group at
a particular client organisation.person - the person to remove from the groupgroup - the grouppublic AdministrationClientOrg[] listClients()
public AdministrationClientOrg getClient(AdministrationClientOrg client)
client - The client organisation to return.public boolean createClient(AdministrationClientOrg client)
client - The client organisation to create.public boolean deleteClient(AdministrationClientOrg client)
client - The client organisation to delete.public boolean updateClient(AdministrationClientOrg client)
client - The client organisation to update.public AdministrationPerson[] getUserAccess(AdministrationClientOrg client)
client - the client organisationpublic AdministrationClientOrg[] getUserAccess(AdministrationPerson person)
person - the userpublic boolean addUserAccess(AdministrationPerson person, AdministrationClientOrg client)
person - the userclient - the client organisation to allow access topublic boolean removeUserAccess(AdministrationPerson person, AdministrationClientOrg client)
person - the userclient - the client organisation to disallow access topublic boolean addBirtReport(AdministrationReport birtReport)
client reference id is set,
the report will be created under that client.public boolean flushGeometry(java.lang.Integer ViewId)
public boolean delGeopack(java.lang.String packId)
public boolean reloadCodes(java.util.ArrayList<java.lang.String> codes)
public boolean removeViewFromCache(java.lang.Integer ViewId)
public boolean removeDocumentFromCache(java.lang.Integer documentId)
public boolean removeContentManagementFromCache(java.lang.Integer contentId)
public boolean removeReportFromCache(java.lang.Integer ReportId)
public boolean removeGroupFromCache(java.lang.Integer groupId)
public boolean removePersonFromCache(java.lang.Integer personId)
public boolean removeTextEntityFromCache(java.lang.Integer textId)
public boolean removeDashboardFromCache(java.lang.Integer tabId)
public boolean reloadLicence()
public boolean closeConnectionPool(java.lang.Integer sourceId)
public boolean flushCachedFilterCache(java.lang.Integer filterId)
public boolean logoutUserByUserName(java.lang.String UserName)
public boolean logoutUserByUserIp(java.lang.Integer UserIp,
java.lang.String ContainerSessionId)
public boolean logoutUserByUserIpWithErrorsSuppressed(java.lang.Integer userIp,
java.lang.String containerSessionId)
userIp - is the internal identifier of the user you wish to logoutcontainerSessionId - is the container sessionId to limit logout to a particular session.public boolean logoutUserByUserName(java.lang.String UserName,
java.lang.String ContainerSessionId)
public boolean logoutUserByUserNameWithErrorsSuppressed(java.lang.String userName,
java.lang.String containerSessionId)
userName - is the username of the user you wish to logoutcontainerSessionId - is the container sessionId to limit logout to a particular session.public boolean isReportFavourite(java.lang.Integer reportId,
java.lang.String loginId)
public boolean isReportFavourite(AdministrationReport report, AdministrationPerson person)
public boolean deleteFavourite(java.lang.Integer reportId,
java.lang.String loginId)
public boolean deleteFavourite(AdministrationReport report, AdministrationPerson person)
public boolean addToFavourites(java.lang.Integer reportId,
java.lang.String loginId)
public boolean addToFavourites(AdministrationReport report, AdministrationPerson person)
public boolean addPersonFavourite(PersonFavourite pf)
public boolean removePersonFavourite(PersonFavourite pf)
public ReportBinaryObject retrieveAvatar(java.lang.String id)
public ReportBinaryObject retrieveAvatar(java.lang.Integer id)
public ReportBinaryObject[] retrieveAvatars(java.lang.Integer[] ids)
public ReportBinaryObject[] retrieveAvatars(java.lang.String[] ids)
public PersonFavourite[] listPersonFavourites(PersonFavourite pf)
public PersonFavourite[] listPersonFavourites(PersonFavourite pf, java.lang.Integer retrospectiveDays)
public boolean approveReport(java.lang.Integer reportId)
public boolean rejectReport(java.lang.Integer reportId)
public boolean addColumnToViews(java.lang.Integer sourceId,
java.lang.String tableName,
java.lang.String columnName,
java.lang.String fieldCategoryName)
sourceId - the Yellowfin SourceId. Only views in this source will be modified.tableName - the name of the table on the database that the column is on.columnName - the column name to add.fieldCategoryName - the name of a field category to add new columns to.public boolean addColumnToViews(java.lang.String dataSourceName,
java.lang.String tableName,
java.lang.String columnName,
java.lang.String fieldCategoryName)
dataSourceName - the name of a Yellowfin data source. Only views in this source will be modified.tableName - the name of the table on the database that the column is on.columnName - the column name to add.fieldCategoryName - the name of a field category to add new columns to.public boolean setAvatarImage(AdministrationPerson person, java.lang.String base64EncodedImage)
person - the person to change the avatar image forbase64EncodedImage - base64 byte array representing the imagepublic int testConnection()
protected AdministrationServiceResponse doWebServicesRequest(AdministrationServiceRequest rsr) throws WebserviceException
Report - Service RequestWebserviceExceptionpublic java.lang.String getServiceURL()
public int getPort()
public java.lang.String getUsername()
public java.lang.String getWebServicesHost()
public java.lang.String[] getMessages()
public java.lang.Integer getErrorCode()
public void setErrorCode(java.lang.Integer errorCode)
public java.lang.String getClientReferenceId()
public AdministrationServiceRequest getRsr()
public void setRsr(AdministrationServiceRequest rsr)
public AdministrationServiceResponse getRs()
public void setRs(AdministrationServiceResponse rs)
public void setClientReferenceId(java.lang.String clientReferenceId)
clientReferenceId - the client reference id to use in web service callspublic java.lang.String getSessionId()
public static final java.lang.String getClientRelease()
public static final java.lang.String getClientBuild()
public boolean flushBinaryClassLoaderCache()
public void refreshAccessLevelList(java.lang.Integer contentId)
public void removeAccessLevelFromCache(java.lang.String contentKey)
public AdministrationSchedule[] listAllSchedules() throws WebserviceException
WebserviceExceptionpublic AdministrationSchedule loadSchedule(java.lang.String scheduleUUID) throws WebserviceException
WebserviceExceptionpublic AdministrationSchedule saveSchedule(AdministrationSchedule schedule) throws WebserviceException
WebserviceExceptionpublic void deleteSchedule(java.lang.String scheduleUUID)
throws WebserviceException
WebserviceExceptionpublic AdministrationSchedule runScheduleNow(java.lang.String scheduleUUID) throws WebserviceException
WebserviceExceptionpublic AdministrationSchedule pauseSchedule(java.lang.String scheduleUUID) throws WebserviceException
WebserviceExceptionpublic AdministrationSchedule resumeSchedule(java.lang.String scheduleUUID) throws WebserviceException
WebserviceExceptionpublic boolean updateAdminMode(java.util.Map<java.lang.String,java.lang.String> functions,
boolean enableAdminMode)
public boolean performCacheCommands(AdministrationCacheCommand[] commands)
public boolean removeFromRESTUserCache(RESTUserCacheRemovalInfo removalInfo)
public byte[] serialize(java.io.Serializable obj)
throws java.io.IOException
java.io.IOException